Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs
Visit the Vonage API Developer PortalUsed 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... | |
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.
| OpenTok.Publisher.Builder.Builder | ( | Context | context | ) |
| Publisher OpenTok.Publisher.Builder.Build | ( | ) |
Creates a Publisher instance based on the Publisher.Builder settings.
|
Publisher audio bitrate. Setting it to 0 will fall back to the default value.
|
Whether publisher has audio auto gain control enabled.
|
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.
|
If enabled, AutoGainControl, NoiseSuppression and EchoCancellation parameters will be ignored and considered disabled.
|
Whether publisher has audio echo cancellation enabled.
|
Whether to include an audio track in the published stream.
|
Whether to include an video track in the published stream.
|
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).
|
Whether publisher has audio noise suppression enabled.
|
Whether to enable Opus DTX in the published stream. Enabling Opus DTX can reduce bandwidth usage in streams that have long periods of silence.
|
Whether to enable publisher audio fallback.
|
The video renderer to use for this publisher. If you do not specify a renderer, the video isn't rendered locally.
|
Whether to allow use of scalable video for a publisher that has the VideoSourceType set to Screen (true) or not (false, the default).
|
Whether to enable stereo audio in the published stream.
|
Whether to enable subscriber audio-fallback.
