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. More...
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). More...
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. More...
bool	HasAudioTrack = true [get, set]
	Whether to include an audio track in the published stream. More...
bool	HasVideoTrack = true [get, set]
	Whether to include an video track in the published stream. More...
bool	Stereo = false [get, set]
	Whether to enable stereo audio in the published stream. More...
uint	AudioBitrate = 0 [get, set]
	Publisher audio bitrate. Setting it to 0 will fall back to the default value. More...
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. More...
bool	AutoGainControl = true [get, set]
	Whether publisher has audio auto gain control enabled. More...
bool	NoiseSuppression = true [get, set]
	Whether publisher has audio noise suppression enabled. More...
bool	EchoCancellation = true [get, set]
	Whether publisher has audio echo cancellation enabled. More...
bool	DisableAudioProcessing = false [get, set]
	If enabled, AutoGainControl, NoiseSuppression and EchoCancellation parameters will be ignored and considered disabled. More...
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). More...
Context	Context [get, set]
	The Context to use for this Publisher object. More...
bool	SubscriberAudioFallback = true [get, set]
	Whether to enable subscriber audio-fallback. More...
bool	PublisherAudioFallback = false [get, set]
	Whether to enable publisher audio fallback. More...

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

context

The 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

Property Documentation

AudioBitrate

uint OpenTok.Publisher.Builder.AudioBitrate = 0

getset

Publisher audio bitrate. Setting it to 0 will fall back to the default value.

AutoGainControl

bool OpenTok.Publisher.Builder.AutoGainControl = true

getset

Whether publisher has audio auto gain control enabled.

Capturer

IVideoCapturer OpenTok.Publisher.Builder.Capturer

getset

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.

Context

Context OpenTok.Publisher.Builder.Context

getset

The Context to use for this Publisher object.

DisableAudioProcessing

bool OpenTok.Publisher.Builder.DisableAudioProcessing = false

getset

If enabled, AutoGainControl, NoiseSuppression and EchoCancellation parameters will be ignored and considered disabled.

EchoCancellation

bool OpenTok.Publisher.Builder.EchoCancellation = true

getset

Whether publisher has audio echo cancellation enabled.

HasAudioTrack

bool OpenTok.Publisher.Builder.HasAudioTrack = true

getset

Whether to include an audio track in the published stream.

HasVideoTrack

bool OpenTok.Publisher.Builder.HasVideoTrack = true

getset

Whether to include an video track in the published stream.

Name

string OpenTok.Publisher.Builder.Name

getset

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).

NoiseSuppression

bool OpenTok.Publisher.Builder.NoiseSuppression = true

getset

Whether publisher has audio noise suppression enabled.

OpusDtx

bool OpenTok.Publisher.Builder.OpusDtx = false

getset

Whether to enable Opus DTX in the published stream. Enabling Opus DTX can reduce bandwidth usage in streams that have long periods of silence.

PublisherAudioFallback

bool OpenTok.Publisher.Builder.PublisherAudioFallback = false

getset

Whether to enable publisher audio fallback.

Renderer

IVideoRenderer OpenTok.Publisher.Builder.Renderer

getset

The video renderer to use for this publisher. If you do not specify a renderer, the video isn't rendered locally.

ScalableScreenshare

bool OpenTok.Publisher.Builder.ScalableScreenshare = false

getset

Whether to allow use of scalable video for a publisher that has the VideoSourceType set to Screen (true) or not (false, the default).

Stereo

bool OpenTok.Publisher.Builder.Stereo = false

getset

Whether to enable stereo audio in the published stream.

SubscriberAudioFallback

bool OpenTok.Publisher.Builder.SubscriberAudioFallback = true

getset

Whether to enable subscriber audio-fallback.

---

The documentation for this class was generated from the following file:

• /Users/jswartz_1/src/native-sdk-src/project/windows/OpenTok/src/Publisher.cs