Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

OpenTok.Publisher.Builder

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

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

Property Documentation

◆ Capturer

IVideoCapturer OpenTok.Publisher.Builder.Capturer

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

The Context to use for this Publisher object.

◆ HasAudioTrack

bool OpenTok.Publisher.Builder.HasAudioTrack = true

Whether to include an audio track in the published stream.

◆ HasVideoTrack

bool OpenTok.Publisher.Builder.HasVideoTrack = true

Whether to include an video track in the published stream.

◆ Name

string OpenTok.Publisher.Builder.Name

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

◆ OpusDtx

bool OpenTok.Publisher.Builder.OpusDtx = false

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

◆ Renderer

IVideoRenderer OpenTok.Publisher.Builder.Renderer

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

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

Whether to enable stereo audio in the published stream.