Skip to content
A lib that brings the web-based API from DVBViewer Media Server into the .Net world
C#
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
DVBViewerServerApiWrapper
DVBViewerServerApiWrapperCLI
images
.gitignore
DVBViewerServerApiWrapper.sln
LICENSE
Readme.md
ToDo.txt
changelog.md

Readme.md

DVBViewerServerApiWrapper

Der DVBViewerServerApiWrapper ist eine Bibliothek, welche die webbasierte API des DVBViewer Media Servers in die .Net Welt holt. Sie wird unter der Verwendung des MediaServers von DVBViewer entwickelt.

The DVBViewerServerApiWrapper is a library that brings the web-based API of the DVBViewer Media Server into the .Net world. It is developed using DVBViewer's MediaServer.

www.dvbviewer.com

Current state and requirements (Aktueller Status und Voraussetzungen)

  • (de) Funktioniert mit dem DVBViewer Media Server 2.0.4.0 und höher.
  • (en) Works with the DVBViewer Media Server 2.0.4.0 and higher.
  • (de) Benötigte .Net Framework Version ist 4.7.1!
  • (en) Required .Net Framework Version is 4.7.1!

Wrapper Version 0.5.0.0

changelog.md for more details

Symbols: Ready, Work, ToDo, Aborted, Canceled


status2.html
version.html
tasks.html
recordings.html
recdelete.html
mediafiles.html -> own implementation over the sql.html
getchannelsxml.html
epg.html
epgclear.html
timerlist.html
timeradd.html
timeredit.html
timerdelete.html
sideload.html
startts.html
stopts.html
searchlist.html
searchdelete.html
searchedit.html
searchadd.html
dvbcommand.html
getconfigfile.html
setting.html -> maybe unnecessary (double support to status2.html)
sql.html - integration in all relevant classes

Using the lib

For an UI-App Demo visit the DMSApiWrapperDemo.

    class Program
    {
        static void Main(string[] args)
        {
            var dvbServ = new DVBViewerServerApi
            {
                IpAddress = "Name-of-PC or IpAddress",
                //Password is now a SecureString, see below
                //Password = "password for guest or admin",
                User = "username for guest or admin",
                Port = 8089
            };

            /*
            / Section with Secure Password
            */

            //Define new SecureString
            var spw = new SecureString();

            //Basics of SecureString
            //Get the password in a CLI app and save it to a SecureString
            ConsoleKeyInfo key;
            Console.Write("Enter the server password: ");
            spw = new SecureString();
            do
            {
                key = Console.ReadKey(true);
                spw.AppendChar(key.KeyChar);
                Console.Write("*");

            } while (key.Key != ConsoleKey.Enter);
            Console.WriteLine();

            //Set the password
            dvbServ.Password = spw;
            spw = null;

            //Using SecureString in a GUI App

            //For the next steps, the Class "Security" is stored under the namespace
            //DVBViewerServerApiWrapper.Helper

            //For set the password as SecureString in WPF or Win-Forms applications
            //Read the password from a PasswordBox
            //Encrypt the Password with 
            byte[] keySecure;
            byte[] keyPublic;
            string pwEncrypted = Security.GenerateEnrcyptedPassword("thePasswort", out keyPublic, out keySecure);

            //Save all, also `keySecure`, `keyPublic` and `pwEncrypted` in the same, better in different places
            //Please save the `keySecure` on a place where the user can access but no other person have access!
            //After the App is new or re-started, load the encrypted values (pwEncrypted, keyPublic, keySecure)

            //Decrypt the password with
            string password = Security.GenerateUnEnrcyptedPassword(pwEncrypted, keyPublic, keySecure);

            //Generate the SecureString
            var securePW = new SecureString();
            foreach (char c in password)
            {
                securePW.AppendChar(c);
            }
            //Set the secure Password to the ApiWrapper
            //the SecureString in the ApiWrapper is readonly
            dvbServ.Password = securePW;
            //Set all vars to null
            password = null;
            securePW = null;
            pwEncrypted = null;
            keySecure = null;
            keyPublic = null;

            /*
            / Section with examples how to use
            */

            try
            {
                
               //Get the serverstatus if online
                var status = dvbServ.Serverstatus;

                Console.WriteLine($"ServerRights: {status.Rights}");
                Console.WriteLine($"EPGUpdate: {status.EPGUpdate}");
                foreach (var item in status.RecordingFolders)
                {
                    Console.WriteLine($"RecordingFolder: {item.Folder}");
                }

                var version = dvbServ.ServerVersion;
                Console.WriteLine($"Serverversion: {version.Version}");

                //All current recordings
                var recsAll = dvbServ.Recordings;
                Console.WriteLine($"Number of recordings: {recsAll.Items.Count}");

                //All current recordings in a shorter and faster way
                var recs = dvbServ.RecordingsShort;

                //All hist recordings ever since database exists (maybe recordings have been deleted, but here exist a copy of the base data)
                var histRecs = dvbServ.RecordedList;

                //All current recordings with "bank" in the name
                var recsN = dvbServ.GetRecordings("bank");
                Console.WriteLine($"Number of recordings with bank in the name: {recsN.Items.Count}");

                //All current recordings with "bank" in the description
                var recsD = dvbServ.GetRecordingsByDescription("bank");
                Console.WriteLine($"Number of recordings with bank in the description: {recsD.Items.Count}");

                //All connected Clients since media server restarts as PC-Names
                var clients = dvbServ.DVBViewerClients;
                Console.WriteLine($"Number of clients connected to MediaServer since start: {clients.Items.Count}");

                var videofiles = dvbServ.VideoFileList;
                Console.WriteLine($"Number of videofiles in MediaServer since last database update: {videofiles.Items.Count}");

                //Neuer Zufallsgenerator
                var rnd = new Random();
                //Neue Zufallszahl erzeugen
                int next = rnd.Next(videofiles.Items.Count);
                //Dem ersten Clienten ein zufälliges Video abspielen lassen
                clients.Items[0].PlayVideo(videofiles.Items[next]);
                Console.WriteLine($"Client \"{clients.Items[0].Name}\" plays video \"{videofiles.Items[next].Title}\"");

                //Get alle VideoFiles with bank in the title
                var filteredFiles = dvbServ.GetVideoList("bank");
                var m3uFile = filteredFiles.CreateM3UFile();
                Console.WriteLine($"Playlist in: {m3uFile}");

                //send it to your video player who was registered with m3u
                System.Diagnostics.Process.Start(m3uFile);

                //Get all Servertasks from the DVBViewer Media Server
                var servertasks = dvbServ.ServerTasks;

                //Get all Series from the RecordingsList
                var serien = RecordingSeries.GetSeries();
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
            }

            Console.ReadKey();
        }
    }

Screenshot C L I

You can’t perform that action at this time.