Sink Property

Visual Basic
C#
C++/CLI

'Declaration
 
Public Property Sink As String

'Usage
 
Dim instance As TargetFormat
Dim value As String
 
instance.Sink = value
 
value = instance.Sink

public string Sink {get; set;}

public:
property String^ Sink {
   String^ get();
   void set (    String^ value);
}

Property Value

A string value representing the sink's name.

When the format is selected, the output from the multiplexer is directly connected to this filter. If the value is undefined (empty string), then an appropriate sink will be created based upon the type of target selected. Attempting to set this value on a ReadOnly item will result in an error. 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 CaptureCtrlForm = New CaptureCtrlForm()
Public Sub TargetFormatsExample()
   ' reference the capture control
   Dim capturectrl As CaptureCtrl = _form.CaptureCtrl

   Try
      ' set the video capture device, use your capture device name here
      If capturectrl.VideoDevices("USB") Is Nothing Then
         Throw New Exception("No USB video device available")
      End If

      capturectrl.VideoDevices("USB").Selected = True

      ' set the audio capture device, use your capture device name here
      If capturectrl.AudioDevices("USB") Is Nothing Then
         Throw New Exception("No USB audio device available")
      End If

      capturectrl.AudioDevices("USB").Selected = True

      ' no recompression for video and audio
      capturectrl.VideoCompressors.Mpeg2.Selected = True
      capturectrl.AudioCompressors.AC3.Selected = True

      ' select the DVD target format
      capturectrl.TargetFormats(TargetFormatType.DVD).Selected = True

      ' get the current selected input
      Dim n As Integer = capturectrl.TargetFormats.Selection

      ' loop through the target formats and set a different one
      For Each t As TargetFormat In capturectrl.TargetFormats
         ' get the format properties
         Dim name As String = t.Name
         Dim sink As String = t.Sink
         Dim sinkSubType As String = t.SinkSubType
         Dim audio As String = t.AudioCompressor
         Dim video As String = t.VideoCompressor
         Dim sRecAudio As String = t.RecommendedAudioCompressor
         Dim sRecVideo As String = t.RecommendedVideoCompressor
         Dim mux As String = t.Mux
         Dim avMux As String = t.AVMux
         Dim sft As StreamFormatType = t.Streams

         ' if we found the video tuner input
         If name = "AVI" Then
            ' select it and break
            t.Selected = True
            Exit For
         End If
      Next t

      ' check it directly
      Dim tft As TargetFormatType = capturectrl.TargetFormat

      ' set the result to what we expect
      _result = (tft <> TargetFormatType.DVD AndAlso n <> capturectrl.TargetFormats.Selection)
   Catch e1 As Exception
      _result = False
   End Try

   ' 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 capturectrl.State = CaptureState.Running
      Application.DoEvents()
   Loop
End Sub

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

public bool _result = false;
public CaptureCtrlForm _form = new CaptureCtrlForm();
public void TargetFormatsExample()
{
   // reference the capture control
   CaptureCtrl capturectrl = _form.CaptureCtrl;

   try
   {
      // set the video capture device. use your capture device's name here
      if (capturectrl.VideoDevices["USB"] == null)
         throw new Exception("No USB video device available");

      capturectrl.VideoDevices["USB"].Selected = true;

      // set the audio capture device. use your capture device's name here
      if (capturectrl.AudioDevices["USB"] == null)
         throw new Exception("No USB audio device available");

      capturectrl.AudioDevices["USB"].Selected = true;

      // no recompression for video and audio
      capturectrl.VideoCompressors.Mpeg2.Selected = true;
      capturectrl.AudioCompressors.AC3.Selected = true;

      // select the DVD target format
      capturectrl.TargetFormats[TargetFormatType.DVD].Selected = true;

      // get the current selected input
      int n = capturectrl.TargetFormats.Selection;

      // loop through the target formats and set a different one
      foreach (TargetFormat t in capturectrl.TargetFormats)
      {
         // get the format properties
         string name = t.Name;
         string sink = t.Sink;
         string sinkSubType = t.SinkSubType;
         string audio = t.AudioCompressor;
         string video = t.VideoCompressor;
         string sRecAudio = t.RecommendedAudioCompressor;
         string sRecVideo = t.RecommendedVideoCompressor;
         string mux = t.Mux;
         string avMux = t.AVMux;
         StreamFormatType sft = t.Streams;

         // if we found the video tuner input
         if (name == "AVI")
         {
            // select it and break
            t.Selected = true;
            break;
         }
      }

      // check it directly
      TargetFormatType tft = capturectrl.TargetFormat;

      // set the result to what we expect
      _result = (tft != TargetFormatType.DVD && n != capturectrl.TargetFormats.Selection);
   }
   catch (Exception)
   {
      _result = false;
   }

   // 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 (capturectrl.State == CaptureState.Running)
      Application.DoEvents();
}

Target Platforms

Reference

TargetFormat Class
TargetFormat Members