OpenTok.Subscriber

Defines values for the VideoEventArgs.Reason and VideoEventArgs.Reason properties.

Creates a new subscriber for a given stream.

Parameters

context	The Content object used to manage resources for the Subscriber.
stream	The Stream object corresponding to the stream you will subscribe to.
renderer	The video renderer for the subscriber. If you do not specify a renderer, the video isn't rendered (and only audio is played back).

Disposes of the Subscriber object's resources.

Gets the RTC stats report for the subscriber. This is an asynchronous operation. When the stats are available, the RtcStatsReport message is sent.

Also see AudioStatsUpdated, VideoStatsUpdated, and Publisher.GetRtcStatsReport().

Called periodically to report the PCM audio data of the subscriber.

Sent periodically to report the audio level of the subscriber.

The audio volume of the subscriber.

The audio volume, between 0 and 100, of the subscriber. When setting the value, if it is not in this range, it will be clamped to it.

The default value is 100.

The unique identifier for the Subscriber.

The preferred framerate for the subscriber’s stream.

Limiting the frame rate and video resolution (PreferredResolution) reduces the network and CPU usage on the subscribing client. You may want to use lower resolution based on the dimensions of subscriber's video in the app. You may want to use a lower frame rate or resolution for subscribers to a stream that is less important (and smaller) than other streams.

This property only applies when subscribing to a stream that uses the scalable video feature. Scalable video is available:

• Only in sessions that use the Vonage Video API Media Router (sessions with the media mode set to routed).
• Only for streams published by clients that support scalable video (see the documentation for the scalable video feature).

In streams that do not use scalable video, setting this property has no effect.

Note: The frame rate for scalable video streams automatically adjusts for each subscriber, based on network conditions and CPU usage, even if you do not set this property. Set this property if you want to set a maximum frame rate for this subscriber.

The frame rates available are based on the value of the maximum frame rate available for the stream. When you set the preferred frame rate for the subscriber, the Vonage Video API Windows SDK picks the best frame rate available that is closest to the preferred frame rate, based on the client's bandwidth and CPU constraints.

The actual frame rates available depend, dynamically, on network and CPU resources available to the publisher.

The preferred resolution for the subscriber’s stream.

The preferred resolution for the subscriber's stream.

Limiting the video resolution and frame rate (PreferredFramerate) reduces the network and CPU usage on the subscribing client. You may want to use lower resolution based on the dimensions of subscriber's video in the app. You may want to use a lower frame rate or resolution for subscribers to a stream that is less important (and smaller) than other streams.

This property only applies when subscribing to a stream that uses the scalable video feature. Scalable video is available:

• Only in sessions that use the Vonage Video API Media Router (sessions with the media mode set to routed).
• Only for streams published by clients that support scalable video (see the documentation for the scalable video feature).

In streams that do not use scalable video, setting this property has no effect.

Note: The resolution for scalable video streams automatically adjusts for each subscriber, based on network conditions and CPU usage, even if you do not set this property. Set this property if you want to set a maximum resolution for this subscriber.

Not every resolution is available to a subscriber. When you set the preferred resolution, the Vonage Video API Windows SDK picks the best resolution available that matches your constraints. The resolutions available depend on the maximum width and height the Publisher sets for the stream, which are returned by the Stream.Width and Stream.Height properties of the Stream object. Each of the resolutions available for a stream will use the same aspect ratio.

Sent in response to a call to GetRtcStatsReport().

The stream for this subscriber. The properties of the Stream object are a snapshot of the stream state at the time this property is accessed, and will not be updated as the state of the stream changes.

Whether the Subscriber is subscribing to audio (true) or not (false).

Whether the Subscriber is subscribing to captions (true) or not (false). The default value is the captions value of the stream's publisher.Publisher.PublishCaptions

Whether the Subscriber is subscribing to video (true) or not (false).

The video renderer used by this subscriber.

Set the video renderer by passing in the VideoRenderer when calling the Subscriber(Context, Stream, IVideoRenderer) constructor.

Invoked when the subscriber has audio stats to share.

Sent when the subscriber's stream receives caption text.

Invoked when the instance has successfully connected to the stream and begins playing media.

Invoked when a subscriber has failed to connect to the Vonage Video API server.

Called when the subscriber's stream has been interrupted.

In response to this method being called, you may want to provide a user interface notification, to let the user know that the audio-video stream is temporarily disconnected and the app is trying to reconnect to the stream.

If the client reconnects to the stream, the Subscribers sends the StreamReconnected event. Otherwise, the Session object sends the Session.StreamDropped event.

Sent when the subscriber's stream resumes (after temporarily being disconnected).

The Subscriber sends this event after it sends the StreamDisconnected event.

Called when the subscriber stops receiving video.

Check the reason property of the event arguments for the reason why the video stopped.

Called when the Vonage Video API Media Router determines that the stream quality has degraded and the video will be disabled if the quality degrades further.

If the quality degrades further, the subscriber disables the video and the Subscriber sends the VideoDisabled message. If the stream quality improves, the Subscriber sends the VideoDisableWarningLifted event.

This feature is only available in sessions that use the Vonage Video API Media Router (sessions with the media mode set to routed), not in sessions with the media mode set to relayed. (See The OpenTok Media Router and media modes).

This method is mainly called when connection quality degrades.

Called when the Vonage Video API Media Router determines that the stream quality has improved to the point at which the video being disabled is not an immediate risk.

This feature is only available in sessions that use the Vonage Video API Media Router (sessions with the media mode set to routed), not in sessions with the media mode set to relayed. (See The OpenTok Media Router and media modes).

This method is mainly called when connection quality improves.

Called when the subscriber's video stream starts (when there previously was no video) or resumes (after video was disabled).

Check the reason property of the event arguments for the reason why the video was enabled.

Invoked when the subscriber has video stats to share.