In This Topic ▼

Sink Property

Summary

Gets or sets the sink's name.

Syntax

C++/CLI

public string Sink { get; set; }

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

Property Value

A string value representing the sink's name.

Remarks

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.

Example

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; 
         bool readOnly = t.ReadOnly; 
         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(); 
}

Requirements

Target Platforms

Reference

TargetFormat Class

TargetFormat Members

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies