Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VideoStream

Hierarchy

  • MediaStream<VideoTrack>
    • VideoStream

Implements

  • IExternalStream
  • IMediaStream
  • IExternalMediaStream
  • IVideoStream
  • IExternalVideoStream

Index

Constructors

Properties

Methods

Constructors

constructor

  • new VideoStream(localTrack: VideoTrack): VideoStream
  • new VideoStream(localTrack: VideoTrack, remoteTrack: VideoTrack): VideoStream
  • new VideoStream(localMedia: LocalMedia): VideoStream
  • new VideoStream(localMedia: LocalMedia, remoteMedia: RemoteMedia): VideoStream
  • new VideoStream(remoteMedia: RemoteMedia): VideoStream

Properties

Private _internal

_internal: IInternalVideoStream
internal

Private localMedia

localMedia: LocalMedia
internal

Private remoteMedia

remoteMedia: RemoteMedia
internal

Methods

_getInternal

  • _getInternal(): IInternalVideoStream

addOnDirectionChange

  • addOnDirectionChange(value: IAction0): void

changeDirection

  • changeDirection(newDirection: StreamDirection): Error

  • Parameters

    • newDirection: StreamDirection

    Returns Error

getDirection

  • getDirection(): StreamDirection

  • Returns StreamDirection

getDynamicProperties

  • getDynamicProperties(): Hash<string, Object>
  • Gets the dynamic properties on this instance.

    Returns Hash<string, Object>

getDynamicValue

  • getDynamicValue(key: string): Object
  • Gets a property value from the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns Object

    The stored value, if found; otherwise null.

getId

  • getId(): string

  • Returns string

getIsDirty

  • getIsDirty(): boolean
  • Gets a value indicating whether this instance is dirty.
    internal

    Returns boolean

getIsSerialized

  • getIsSerialized(): boolean

getLabel

  • getLabel(): string

  • Returns string

getLocalBandwidth

  • getLocalBandwidth(): number

getLocalDirection

  • getLocalDirection(): StreamDirection

getLocalMedia

  • getLocalMedia(): LocalMedia

  • Returns LocalMedia

getLocalReceive

  • getLocalReceive(): boolean

getLocalSend

  • getLocalSend(): boolean

getLocalTrack

  • getLocalTrack(): VideoTrack

getMuted

  • getMuted(): boolean

getRemoteBandwidth

  • getRemoteBandwidth(): number

getRemoteDirection

  • getRemoteDirection(): StreamDirection

getRemoteMedia

  • getRemoteMedia(): RemoteMedia

  • Returns RemoteMedia

getRemoteReceive

  • getRemoteReceive(): boolean

getRemoteSend

  • getRemoteSend(): boolean

getRemoteTrack

  • getRemoteTrack(): VideoTrack

getSerialized

  • getSerialized(): string

getTag

  • getTag(): string

  • Returns string

getType

  • getType(): StreamType

  • Returns StreamType

getTypeString

  • getTypeString(): string

removeOnDirectionChange

  • removeOnDirectionChange(value: IAction0): void

setDynamicProperties

  • setDynamicProperties(value: Hash<string, Object>): void
  • internal

    Parameters

    • value: Hash<string, Object>

    Returns void

setDynamicValue

  • setDynamicValue(key: string, value: Object): void
  • Sets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    • value: Object

      The property value. This can be any object that needs to be stored for future use.

    Returns void

setId

  • setId(value: string): void

  • Parameters

    • value: string

    Returns void

setIsDirty

  • setIsDirty(value: boolean): void
  • Sets a value indicating whether this instance is dirty.
    internal

    Parameters

    • value: boolean

    Returns void

setIsSerialized

  • setIsSerialized(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setLocalBandwidth

  • setLocalBandwidth(value: number): void

setLocalDirection

  • setLocalDirection(value: StreamDirection): void

  • Parameters

    • value: StreamDirection

    Returns void

setLocalReceive

  • setLocalReceive(receiveEnabled: boolean): void

  • Parameters

    • receiveEnabled: boolean

    Returns void

setLocalSend

  • setLocalSend(sendEnabled: boolean): void

  • Parameters

    • sendEnabled: boolean

    Returns void

setMuted

  • setMuted(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setTag

  • setTag(value: string): void

  • Parameters

    • value: string

    Returns void

unsetDynamicValue

  • unsetDynamicValue(key: string): boolean
  • Unsets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns boolean

    true if the value was removed; otherwise, false.