Suggestions

close search

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

Visit the Vonage API Developer Portal

OpenTok.Stream

Represents an audio-video stream in an OpenTok session. More...

Inherits IDisposable.

Public Member Functions

void Dispose ()
 Disposes of the Stream object's resources. More...
override bool Equals (object obj)
override int GetHashCode ()

Protected Member Functions

virtual void Dispose (bool disposing)

Properties

string Id [get]
 The unique identifier for this stream. More...
string Name [get]
 The name of the stream. You can display this name to identify the stream's publisher. More...
bool HasAudio [get]
 Whether this stream has video (true) or not (false). More...
bool HasVideo [get]
 Whether this stream has video (true) or not (false). More...
int Width [get]
 The width of the video from this stream. More...
int Height [get]
 The height of the video from this stream. More...
DateTime CreationTime [get]
 The creation time of this stream. More...
VideoSourceType VideoSourceType [get]
 The video source type of the stream (camera, screen, custom), as defined by the OpenTok.VideoSourceType enum. More...
Connection Connection [get]
 The Connection object corresponding to the client that is publishing the stream. More...

Detailed Description

Represents an audio-video stream in an OpenTok session.

The Session object sends the Session.StreamReceived event when there is a new stream in the session.

The Session sends a Session.StreamDropped event when a stream is dropped from the session (for example, when it is unpublished).

Member Function Documentation

◆ Dispose()

void OpenTok.Stream.Dispose ( )

Disposes of the Stream object's resources.

Property Documentation

◆ Connection

Connection OpenTok.Stream.Connection

The Connection object corresponding to the client that is publishing the stream.

◆ CreationTime

DateTime OpenTok.Stream.CreationTime

The creation time of this stream.

◆ HasAudio

bool OpenTok.Stream.HasAudio

Whether this stream has video (true) or not (false).

◆ HasVideo

bool OpenTok.Stream.HasVideo

Whether this stream has video (true) or not (false).

◆ Height

int OpenTok.Stream.Height

The height of the video from this stream.

◆ Id

string OpenTok.Stream.Id

The unique identifier for this stream.

◆ Name

string OpenTok.Stream.Name

The name of the stream. You can display this name to identify the stream's publisher.

◆ VideoSourceType

VideoSourceType OpenTok.Stream.VideoSourceType

The video source type of the stream (camera, screen, custom), as defined by the OpenTok.VideoSourceType enum.

◆ Width

int OpenTok.Stream.Width

The width of the video from this stream.