Vonage Video API Windows SDK
Public Member Functions | Properties | List of all members
OpenTok.Publisher.Builder Class Reference

Used to create a Publisher instance. More...

Public Member Functions

 Builder (Context context)
 Creates a new Builder instance. More...
 
Publisher Build ()
 Creates a Publisher instance based on the Publisher.Builder settings. More...
 

Properties

IVideoCapturer Capturer [get, set]
 The video capturer to use for this publisher. If you do not specify a capturer, the Publisher uses the default video capturer, defined by the VideoCapturer class. This video capturer uses the first video device in the list of devices available on the system.
 
string Name [get, set]
 The name of the publisher video. The Stream.Name property for a stream published by this publisher will be set to this value (on all clients).
 
IVideoRenderer Renderer [get, set]
 The video renderer to use for this publisher. If you do not specify a renderer, the video isn't rendered locally.
 
bool HasAudioTrack = true [get, set]
 Whether to include an audio track in the published stream.
 
bool HasVideoTrack = true [get, set]
 Whether to include an video track in the published stream.
 
bool Stereo = false [get, set]
 Whether to enable stereo audio in the published stream.
 
uint AudioBitrate = 0 [get, set]
 Publisher audio bitrate. Setting it to 0 will fall back to the default value.
 
bool OpusDtx = false [get, set]
 Whether to enable Opus DTX in the published stream. Enabling Opus DTX can reduce bandwidth usage in streams that have long periods of silence.
 
bool AutoGainControl = true [get, set]
 Whether publisher has audio auto gain control enabled.
 
bool NoiseSuppression = true [get, set]
 Whether publisher has audio noise suppression enabled.
 
bool EchoCancellation = true [get, set]
 Whether publisher has audio echo cancellation enabled.
 
bool DisableAudioProcessing = false [get, set]
 If enabled, AutoGainControl, NoiseSuppression and EchoCancellation parameters will be ignored and considered disabled.
 
bool ScalableScreenshare = false [get, set]
 Whether to allow use of scalable video for a publisher that has the VideoSourceType set to Screen (true) or not (false, the default).
 
Context Context [get, set]
 The Context to use for this Publisher object.
 
bool SubscriberAudioFallback = true [get, set]
 Whether to enable subscriber audio-fallback.
 
bool PublisherAudioFallback = false [get, set]
 Whether to enable publisher audio fallback.
 
bool AllowAudioCaptureWhileMuted = false [get, set]
 If set to false, the microphone will be automatically switched off when all publishers have muted their audio. Microphone will be automatically switched on again when at least one
publisher unmutes their audio. If set to true, mic will always remain switched on even when all publishers have muted their audio. Be aware that when the microphone is switched off, callbacks like AudioLevel or AudioData will no longer be invoked for the publishers. The default value is false.
 

Detailed Description

Used to create a Publisher instance.

Instantiate a Builder instance by calling the Builder() constructor. Then (optionally), set properties of the Builder object. Then call the Build() method to create a Publisher object.

Constructor & Destructor Documentation

◆ Builder()

OpenTok.Publisher.Builder.Builder ( Context  context)

Creates a new Builder instance.

Parameters
contextThe Context to use for the Publisher object.

Member Function Documentation

◆ Build()

Publisher OpenTok.Publisher.Builder.Build ( )

Creates a Publisher instance based on the Publisher.Builder settings.

Returns