ClosedCaptioning Property (PlayCtrl)

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overridable Property ClosedCaptioning As Boolean

'Usage
 
Dim instance As PlayCtrl
Dim value As Boolean
 
instance.ClosedCaptioning = value
 
value = instance.ClosedCaptioning

public virtual bool ClosedCaptioning {get; set;}

public:
virtual property bool ClosedCaptioning {
   bool get();
   void set (    bool value);
}

Property Value

true if closed captioning is enabled; false, if closed captioning is disabled. the default value is false.

Closed captioning is the text transcription of the audio stream overlaid on the video frame.

Assignment can raise an error exception. For more information, refer to the Error Codes.

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

Copy Code

Imports Leadtools
Imports Leadtools.Multimedia
Imports LeadtoolsMultimediaExamples.Fixtures

Public _result As Boolean = False
Public _form As PlayCtrlForm = New PlayCtrlForm()
Public _playctrl As PlayCtrl
Public Sub ClosedCaptioningExample()
   ' reference the capture control
   _playctrl = _form.PlayCtrl

   ' input file names
   Dim inFile As String = Path.Combine(LEAD_VARS.MediaDir, "VIDEO_TS.IFO")

   Try
      ' turn off auto start
      _playctrl.AutoStart = False

      ' use DVD source
      _playctrl.UseDVDSource = True

      ' set the allowed stream types
      _playctrl.AllowedStreams = StreamFormatType.AudioVideoCC

      ' set the source file
      _playctrl.SourceFile = inFile

      ' check if closed captioning is enabled
      If _playctrl.ClosedCaptioning = False Then
         ' try to toggle closed captioning 
         _playctrl.ToggleClosedCaptioning()
      End If

      ' if closed captioning is available
      If _playctrl.ClosedCaptioning Then
         ' set the result
         _result = True
      End If

      ' start the playback
      _playctrl.Run()

      ' we'll loop on the state and pump messages for this example.
      ' but you should not need to if running from a Windows Forms application.
      Do While _playctrl.State = PlayState.Running
         Application.DoEvents()
      Loop
   Catch e1 As Exception
      _result = False
   End Try
End Sub

Public NotInheritable Class LEAD_VARS
Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 18\Media"
End Class

using Leadtools;
using Leadtools.Multimedia;
using LeadtoolsMultimediaExamples.Fixtures;

public bool _result = false;
public PlayCtrlForm _form = new PlayCtrlForm();
public PlayCtrl _playctrl;
public void ClosedCaptioningExample()
{
   // reference the capture control
   _playctrl = _form.PlayCtrl;

   // input file names
   string inFile =Path.Combine(LEAD_VARS.MediaDir,"VIDEO_TS.IFO");

   try
   {
      // turn off auto start
      _playctrl.AutoStart = false;

      // use DVD source
      _playctrl.UseDVDSource = true;

      // set the allowed stream types
      _playctrl.AllowedStreams = StreamFormatType.AudioVideoCC;

      // set the source file
      _playctrl.SourceFile = inFile;

      // check whether closed captioning is enabled
      if (_playctrl.ClosedCaptioning == false)
      {
         // try to toggle closed captioning 
         _playctrl.ToggleClosedCaptioning();
      }

      // if closed captioning is available
      if (_playctrl.ClosedCaptioning)
      {
         // set the result
         _result = true;
      }

      // start the playback
      _playctrl.Run();

      // we'll loop on the state and pump messages for this example.
      // but you should not need to if running from a Windows Forms application.
      while (_playctrl.State == PlayState.Running)
         Application.DoEvents();
   }
   catch (Exception)
   {
      _result = false;
   }
}

static class LEAD_VARS
{
public const string MediaDir = @"C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 18\Media";
}

Target Platforms

Reference

PlayCtrl Class
PlayCtrl Members