OTStream

An OTStream object represents a stream of multimedia, which may contain video and/or audio data.

Use OTStream instances to initialize OTSubscriber interfaces. Do not attempt to initialize an OTStream directly.

Properties

connection

Type: OTConnection *

The OTConnection object corresponding to the connection that is publishing the stream. You can compare this to to the [OTSession connection] property to see if the stream is being published by the local device.

session

Type: OTSession *

The session (an OTSession object) the stream is bound to.

streamId

Type: NSString *

The unique ID of the stream.

creationTime

Type: NSDate *

The timestamp for the creation of the stream on the OpenTok media server.

name

Type: NSString *

The name of the stream. In the OpenTok iOS SDK, you can specify a published stream's name when you when you sent the [OTPublisherKit initWithDelegate:settings:] message.

hasAudio

Type: BOOL

Whether the stream is publishing audio (YES) or not (NO). See [OTPublisherKit publishAudio] and [OTSubscriberKit subscribeToAudio].

hasVideo

Type: BOOL

Whether the stream is publishing video (YES) or not (NO). See [OTPublisherKit publishVideo] and [OTSubscriberKit subscribeToVideo].

hasCaptions

Type: BOOL

Whether the stream is publishing captions (YES) or not (NO). See [OTPublisherKit publishCaptions] and [OTSubscriberKit subscribeToCaptions].

videoDimensions

Type: CGSize

The publisher's capturer target resolution for this stream, as last signaled to the session. This value is broadcast to all session participants and is readable on both the publishing and subscribing clients.

This property can change at runtime when the publisher changes the capture resolution, for example due to a device orientation change or a change in capture settings.

Note: This represents the publisher's capturer target resolution, not the resolution actually encoded or received by a subscriber. The publisher may encode at a lower resolution due to bandwidth or CPU constraints.

For streams that use the scalable video feature, this is set to the maximum resolution available for the stream. For more information on scalable video, see the documentation for the OpenTok Media Router.

videoType

Type: OTStreamVideoType

Specifies the type of video for this stream.

This property is set one of the following values:

• OTStreamVideoTypeScreen — The stream's video encoding is optimized for screen sharing.
• OTStreamVideoTypeCamera — The stream is not optimized for screen sharing (for example, it uses a camera as the video source).
• OTStreamVideoTypeCustom — The custom stream video type applies only to Web generated streams.

For more information, see [OTPublisherKit videoType].