Inherits from NSObject
Declared in OTStream.h

Overview

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.

Tasks

Getting basic stream information

  •   connection

    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.

         property
  •   session

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

         property
  •   streamId

    The unique ID of the stream.

         property
  •   type

    The type of the stream. This value can be "basic" or "archive". The value "basic" identifies a stream published by a user connected to the session. The value "archive" identifies an archive stream (from an archive being played back).

         property
  •   creationTime

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

         property
  •   name

    The name of the stream. In the OpenTok iOS SDK, you can specify a published stream’s name when you send the [OTPublisher initWithDelegate:name:] message.

         property

Getting audio and video information

Properties

connection

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.

@property (readonly, strong) OTConnection *connection

Declared In

OTStream.h

creationTime

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

@property (readonly, strong) NSDate *creationTime

Declared In

OTStream.h

hasAudio

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

@property (readonly) BOOL hasAudio

Declared In

OTStream.h

hasVideo

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

@property (readonly) BOOL hasVideo

Declared In

OTStream.h

name

The name of the stream. In the OpenTok iOS SDK, you can specify a published stream’s name when you send the [OTPublisher initWithDelegate:name:] message.

@property (readonly) NSString *name

Declared In

OTStream.h

session

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

@property (readonly) OTSession *session

Declared In

OTStream.h

streamId

The unique ID of the stream.

@property (readonly, strong) NSString *streamId

Declared In

OTStream.h

type

The type of the stream. This value can be "basic" or "archive". The value "basic" identifies a stream published by a user connected to the session. The value "archive" identifies an archive stream (from an archive being played back).

@property (readonly) NSString *type

Declared In

OTStream.h

videoDimensions

The current dimensions of the video media track on this stream. This property can change if a stream published from an iOS device resizes, based on a change in the device orientation. When this occurs, the [OTSubscriberDelegate stream:didChangeVideoDimensions:] message is sent (for an OTSubscriber subscribing to the stream).

@property (readonly) CGSize videoDimensions

Discussion

This property is available for WebRTC only.

Declared In

OTStream.h