ClosedCaptioning Property

Summary
Gets a value that indicates whether closed captioning is enabled.
Syntax
C#
C++/CLI
public virtual bool ClosedCaptioning { get; set; } 
public: 
virtual property bool ClosedCaptioning { 
   bool get(); 
   void set (    bool ); 
} 

Property Value

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

Remarks

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.

Example
C#
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, "SourceVideoCC.avi"); 
 
   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:\LEADTOOLS23\Media"; 
} 
Requirements

Target Platforms

See Also

Reference

PlayCtrl Class

PlayCtrl Members

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Multimedia Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.