In This Topic ▼

FriendlyName Property

Summary

Gets the renderer's descriptive name.

Syntax

C++/CLI

public string FriendlyName {get;}

public: 
property String^ FriendlyName { 
   String^ get(); 
}

Property Value

A string that represents the renderer's descriptive name

Remarks

The returned name is not unique. However, it is ideal for presenting a descriptive name in user interfaces.

Example

using Leadtools; 
using Leadtools.MediaFoundation; 
using LeadtoolsMediaFoundationExamples.Fixtures; 
 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
public CaptureCtrl _capturectrl; 
 
public void AudioRenderersExample() 
{ 
   // output file 
   string outFile = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_AudioRenderersExample.avi"); 
 
   // reference the capture control 
   _capturectrl = _form.CaptureCtrl; 
 
   try 
   { 
      // set the source video device, select using your device name here 
      if (_capturectrl.VideoDevices["USB"] == null) 
         throw new Exception("No USB video device available"); 
 
      _capturectrl.VideoDevices["USB"].Selected = true; 
 
 
      // set the target file 
      _capturectrl.TargetFile = outFile; 
 
      // reference the audio renderers collection 
      AudioRenderers ar = _capturectrl.AudioRenderers; 
 
      // get the current selection 
      int currSelection = ar.Selection; 
 
      // loop through the capture control's registered audio renderers 
      foreach (Renderer r in ar) 
      { 
         // select by renderer friendly name 
         if (r.FriendlyName == "Default DirectSound Device" && r != ar[currSelection]) 
         { 
            // select it 
            r.Selected = true; 
            break; 
         } 
 
         // select by renderer name (device name) 
         if (r.Name == @"@device:cm:{E0F158E1-CB04-11D0-BD4E-00A0C911CE86}\Default DirectSound Device" && r != ar[currSelection]) 
         { 
            // select it 
            r.Selected = true; 
            break; 
         } 
      } 
 
      // check the new selection 
      int newSelection = ar.Selection; 
 
      // set the result to what we expect 
      _result = (currSelection != newSelection); 
 
      // set the started event handler 
      _capturectrl.Started += new EventHandler(CaptureCtrl_Started); 
 
      // run the capture 
      _capturectrl.StartCapture(CaptureMode.Video); 
   } 
   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(); 
} 
 
public void CaptureCtrl_Started(object sender, EventArgs e) 
{ 
   // stop the capture 
   _capturectrl.StopCapture(); 
} 
 
static class LEAD_VARS 
{ 
   public const string MediaDir = @"C:\LEADTOOLS22\Media"; 
}

Requirements

Target Platforms

Reference

Renderer Class

Renderer Members

Download our FREE evaluation

Help Version 22.0.2022.12.7

Leadtools.MediaFoundation Assembly

Introduction

Getting Started

Namespaces

Leadtools.MediaFoundation Namespace

Leadtools.MediaFoundation.Common Namespace

Assemblies