C8110 - media playback status

[MichalOplt]

Hello,

I can play a media clip by calling this API endoint:
http://{{address}}/axis-cgi/mediaclip.cgi?event=play&clip=41

Is there a way that I can see whether the media clip is currently playing or that is done playing? If it is done by events, please, can you give me a direct url where I can see the status? I did not quite understand the instructions from the manual.

Thanks
Michal

[github-actions[bot]]

This automatically generated reply acts as a friendly reminder.

Answers to your questions will most often come from the community, from developers like yourself. You will, from time to time, find that Axis employees answers some of the questions, but this is not a guarantee. Think of the discussion forum as a complement to other support channels, not a replacement to any of them.

If your question remains unanswered for a period of time, please revisit it to see whether it can be improved by following the guidelines listed in Axis support guidelines.

[vivekatoffice]

Hi @MichalOplt ,
Which programming language you are using for your application?

[MichalOplt]

Hi @vivekatoffice,

I am planning to use C# .NET, but first I just wanted to test the API interface with Postman.

Thanks
Michal

[vivekatoffice]

Hi @MichalOplt ,
I have never tested this using Postman but do let me know if you succeed 😄

There are two ways you can do it in C#:

1. Using AXIS Media Parser SDK:

2.Using WebSocket

This part of the API for subscribing to event like tnsaxis:MediaClip/tnsaxis:Playing (link) may be possible using Websocket in C#.

You can explore this library.

Axis Websocket events details: Event streaming over WebSocket

Adding my sample code below:

Program.cs (Please change the PayloadWithFilter according to your needs(tnsaxis:MediaClip/tnsaxis:Playing))

using System;
using System.Threading;
using WebSocketSharp;
using WebSocketSharp.Net;

namespace Example
{
  public class Program
  {
    public static void Main (string[] args)
    {
            Console.WriteLine("Enter username:");

            // Create a string variable and get user input from the keyboard and store it in the variable
            string userName = Console.ReadLine();
            if(userName == String.Empty)
            {
                userName = "root";
            }

            Console.WriteLine("Enter password:");


            // Create a string variable and get user input from the keyboard and store it in the variable
            string password = Console.ReadLine();

            if (password == String.Empty)
            {
                password = "pass";
            }

            Console.WriteLine("Enter Camera IP address:");

            // Create a string variable and get user input from the keyboard and store it in the variable
            string IP_address = Console.ReadLine();
            if (IP_address == String.Empty)
            {
                IP_address = "192.168.55.176";
            }


            string ws_url = "ws://"+IP_address + "/vapix/ws-data-stream?sources=events";


            Console.WriteLine("Username is: " + userName+ " and Password is: " + password);
            Console.WriteLine(ws_url);
            Console.WriteLine("Want to use filters? (y/n)");
            string filterFlag = Console.ReadLine();
            // Create a new instance of the WebSocket class.
            //
            // The WebSocket class inherits the System.IDisposable interface, so you can
            // use the using statement. And the WebSocket connection will be closed with
            // close status 1001 (going away) when the control leaves the using block.
            //
            // If you would like to connect to the server with the secure connection,
            // you should create a new instance with a wss scheme WebSocket URL.
            String Payload = "{\"apiVersion\":\"1.0\",\"method\":\"events:configure\",\"params\":{\"eventFilterList\":[{\"topicFilter\":\"\"}]}}";
            Console.WriteLine(Payload);
            String PayloadWithFilter = "{\"apiVersion\":\"1.0\",\"method\":\"events:configure\",\"params\":{\"eventFilterList\":[{\"topicFilter\":\"tns1:Device/tnsaxis:IO/OutputPort\",\"contentFilter\":\"boolean(//SimpleItem[@Name=\\\"port\\\"and@Value=\\\"1\\\"])\"}]}}";
            Console.WriteLine(PayloadWithFilter);
      using (var ws = new WebSocket (ws_url))
      {
                // Set the WebSocket events.
                if (filterFlag =="y" || filterFlag =="yes")
                {
                    ws.OnOpen += (sender, e) => ws.Send(PayloadWithFilter);
                }
                else
                {
                    ws.OnOpen += (sender, e) => ws.Send(Payload);
                }
        

        ws.OnMessage += (sender, e) => {
            var fmt = "[WebSocket Message] {0}";
            var body = !e.IsPing ? e.Data : "A ping was received.";

            Console.WriteLine (fmt, body);
          };

        ws.OnError += (sender, e) => {
            var fmt = "[WebSocket Error] {0}";

            Console.WriteLine (fmt, e.Message);
          };

        ws.OnClose += (sender, e) => {
            var fmt = "[WebSocket Close ({0})] {1}";

            Console.WriteLine (fmt, e.Code, e.Reason);
          };
#if DEBUG
        // To change the logging level.
        ws.Log.Level = LogLevel.Trace;

        // To change the wait time for the response to the Ping or Close.
        //ws.WaitTime = TimeSpan.FromSeconds (10);

        // To emit a WebSocket.OnMessage event when receives a ping.
        //ws.EmitOnPing = true;
#endif
        // To enable the Per-message Compression extension.
        //ws.Compression = CompressionMethod.Deflate;

        // To validate the server certificate.
        /*
        ws.SslConfiguration.ServerCertificateValidationCallback =
          (sender, certificate, chain, sslPolicyErrors) => {
            var fmt = "Certificate:\n- Issuer: {0}\n- Subject: {1}";
            var msg = String.Format (
                        fmt, certificate.Issuer, certificate.Subject
                      );

            ws.Log.Debug (msg);

            return true; // If the server certificate is valid.
          };
         */

        // To send the credentials for the HTTP Authentication (Basic/Digest).
        ws.SetCredentials (userName, password, false);

        // To send the Origin header.
        //ws.Origin = "http://localhost:4649";

        // To send the cookies.
        //ws.SetCookie (new Cookie ("name", "nobita"));
        //ws.SetCookie (new Cookie ("roles", "\"idiot, gunfighter\""));

        // To connect through the HTTP Proxy server.
        //ws.SetProxy ("http://localhost:3128", "nobita", "password");

        // To enable the redirection.
        //ws.EnableRedirection = true;

        // Connect to the server.
        ws.Connect ();

        // Connect to the server asynchronously.
        //ws.ConnectAsync ();

        Console.WriteLine ("\nType 'exit' to exit.\n");

        while (true) {
          Thread.Sleep (1000);
          Console.Write ("> ");

          var msg = Console.ReadLine ();

          if (msg == "exit")
            break;

          // Send a text message.
          ws.Send (msg);
        }
      }
    }
  }
}

[MichalOplt]

Thanks

I would like to proceed with the AXIS Media Parser SDK:

Is it a suitable way to both make the device play the stored media clips as well as capture events?

Thanks
Michal

[vivekatoffice]

Great 🎆
To play media clips you may need to depend on calling VAPIX APIs 😄