VideoFrameRate Property

Retrieves or sets the output video frame rate.

Syntax

C#
Visual Basic
Objective-C
Java
C++

public double VideoFrameRate {get; set;}

'Declaration

Public Property VideoFrameRate As Double

'Usage

Dim instance As LiveStream
Dim value As Double
 
instance.VideoFrameRate = value
 
value = instance.VideoFrameRate

public:
property double VideoFrameRate {
   double get();
   void set (    double value);
}

Property Value

The output video frame rate in frames per second.

Remarks

The new frame rate value should be between 0.001 and 72.0.

Example

C#
Visual Basic
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.MediaStreaming

Public _server As Server = Nothing
Public _result As Boolean = False

Public Sub PrintLiveStreamsExample()
  Try
     Dim strLiveStreams As String = ""

     ' create an instance of the server object
     _server = New Leadtools.MediaStreaming.Server()

     ' retrieve a copy of the Live Streams
     Dim Streams As LiveStreams = _server.GetLiveStreams()

     strLiveStreams &= String.Format("--- Live Streams (count = {0}) ---" & Constants.vbLf + Constants.vbLf, Streams.Count.ToString())

     ' print the all live streams properties to a string

     Dim nIndex As Integer = 0
     Do While nIndex < Streams.Count
       Dim stream As LiveStream = Streams.GetLiveStream(nIndex)

       strLiveStreams &= String.Format("Live Stream[{0}]: Path = ""{1}""." & Constants.vbLf, nIndex.ToString(), stream.Path)

       Dim nSelection As Integer = stream.VideoDevices.Selection
       Dim strDevice As String = ""
       If nSelection < 0 Then
         strDevice = "<none selected>"
       Else
         strDevice = stream.VideoDevices(nSelection).FriendlyName
       End If

       strLiveStreams &= String.Format("Video Device = ""{0}""." & Constants.vbLf, strDevice)

       nSelection = stream.AudioDevices.Selection
       strDevice = ""
       If nSelection < 0 Then
         strDevice = "<none selected>"
       Else
         strDevice = stream.AudioDevices(nSelection).FriendlyName
       End If

       strLiveStreams &= String.Format("Audio Device = ""{0}""." & Constants.vbLf, strDevice)

       strLiveStreams &= String.Format("Video Width = ""{0}""." & Constants.vbLf, stream.VideoWidth.ToString())

       strLiveStreams &= String.Format("Video Height = ""{0}""." & Constants.vbLf, stream.VideoHeight.ToString())

       If stream.UseVideoInputSize Then
         strLiveStreams &= String.Format("Use Video Input Size = ""true""." & Constants.vbLf)
       Else
         strLiveStreams &= String.Format("Use Video Input Size = ""false""." & Constants.vbLf)
       End If

       strLiveStreams &= String.Format("Video Frame Rate = ""{0}""." & Constants.vbLf, stream.VideoFrameRate.ToString())

       If stream.UseVideoInputFrameRate Then
         strLiveStreams &= String.Format("Use Video Input Frame Rate = ""true""." & Constants.vbLf)
       Else
         strLiveStreams &= String.Format("Use Video Input Frame Rate = ""false""." & Constants.vbLf)
       End If

       strLiveStreams &= String.Format("Video Bit Rate = ""{0}""." & Constants.vbLf, stream.VideoBitRate.ToString())

       If stream.QSVAcceleration Then
         strLiveStreams &= String.Format("QSVAcceleration = ""true""." & Constants.vbLf)
       Else
         strLiveStreams &= String.Format("QSVAcceleration = ""false""." & Constants.vbLf)
       End If

       If stream.CUDAAcceleration Then
         strLiveStreams &= String.Format("CUDAAcceleration = ""true""." & Constants.vbLf)
       Else
         strLiveStreams &= String.Format("CUDAAcceleration = ""false""." & Constants.vbLf)
       End If

       nSelection = stream.AudioTypes.Selection
       Dim strType As String = ""
       If nSelection < 0 Then
         strType = "<none selected>"
       Else
         strType = stream.AudioTypes(nSelection).FriendlyName
       End If

       If stream.UseDeviceEncoding Then
         strLiveStreams &= String.Format("Use Device Encoding = ""true""." & Constants.vbLf)
       Else
         strLiveStreams &= String.Format("Use Device Encoding = ""false""." & Constants.vbLf)
       End If

       strLiveStreams &= String.Format("Minimum Fragment Duration = ""{0}""." & Constants.vbLf, stream.MinimumFragmentDuration.ToString())
        nIndex += 1
     Loop

     ' display a message contains the Live Streams information string
     MessageBox.Show(strLiveStreams, "LEADTOOLS Media Streaming Examples", MessageBoxButtons.OK, MessageBoxIcon.Information)

     _result = True
  Catch e1 As Exception
     _result = False
  End Try
End Sub

using Leadtools;
using Leadtools.MediaStreaming;

public Server _server = null;
public bool _result = false;

public void PrintLiveStreamsExample()
{
   try
   {
      string strLiveStreams = "";

      // create an instance of the server object
      _server = new Leadtools.MediaStreaming.Server();

      // retrieve a copy of the Live Streams
      LiveStreams Streams = _server.GetLiveStreams();

      strLiveStreams += string.Format("--- Live Streams (count = {0}) ---\n\n", Streams.Count.ToString());

      // print the all live streams properties to a string

      for (int nIndex = 0; nIndex < Streams.Count; nIndex++)
      {
         LiveStream stream = Streams.GetLiveStream(nIndex);

         strLiveStreams += string.Format("Live Stream[{0}]: Path = \"{1}\".\n", nIndex.ToString(), stream.Path);

         int nSelection = stream.VideoDevices.Selection;
         string strDevice = "";
         if (nSelection < 0)
            strDevice = "<none selected>";
         else
            strDevice = stream.VideoDevices[nSelection].FriendlyName;

         strLiveStreams += string.Format("Video Device = \"{0}\".\n", strDevice);

         nSelection = stream.AudioDevices.Selection;
         strDevice = "";
         if (nSelection < 0)
            strDevice = "<none selected>";
         else
            strDevice = stream.AudioDevices[nSelection].FriendlyName;

         strLiveStreams += string.Format("Audio Device = \"{0}\".\n", strDevice);

         strLiveStreams += string.Format("Video Width = \"{0}\".\n", stream.VideoWidth.ToString());

         strLiveStreams += string.Format("Video Height = \"{0}\".\n", stream.VideoHeight.ToString());

         if (stream.UseVideoInputSize)
            strLiveStreams += string.Format("Use Video Input Size = \"true\".\n");
         else
            strLiveStreams += string.Format("Use Video Input Size = \"false\".\n");

         strLiveStreams += string.Format("Video Frame Rate = \"{0}\".\n", stream.VideoFrameRate.ToString());

         if (stream.UseVideoInputFrameRate)
            strLiveStreams += string.Format("Use Video Input Frame Rate = \"true\".\n");
         else
            strLiveStreams += string.Format("Use Video Input Frame Rate = \"false\".\n");

         strLiveStreams += string.Format("Video Bit Rate = \"{0}\".\n", stream.VideoBitRate.ToString());

         if (stream.QSVAcceleration)
            strLiveStreams += string.Format("QSVAcceleration = \"true\".\n");
         else
            strLiveStreams += string.Format("QSVAcceleration = \"false\".\n");

         if (stream.CUDAAcceleration)
            strLiveStreams += string.Format("CUDAAcceleration = \"true\".\n");
         else
            strLiveStreams += string.Format("CUDAAcceleration = \"false\".\n");

         nSelection = stream.AudioTypes.Selection;
         string strType = "";
         if (nSelection < 0)
            strType = "<none selected>";
         else
            strType = stream.AudioTypes[nSelection].FriendlyName;

         if (stream.UseDeviceEncoding)
            strLiveStreams += string.Format("Use Device Encoding = \"true\".\n");
         else
            strLiveStreams += string.Format("Use Device Encoding = \"false\".\n");

         strLiveStreams += string.Format("Minimum Fragment Duration = \"{0}\".\n", stream.MinimumFragmentDuration.ToString());
      }

      // display a message contains the Live Streams information string
      MessageBox.Show(strLiveStreams, "LEADTOOLS Media Streaming Examples", MessageBoxButtons.OK, MessageBoxIcon.Information);

      _result = true;
   }
   catch (Exception)
   {
      _result = false;
   }
}

Requirements

Target Platforms

Reference

LiveStream Class
LiveStream Members