Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PluginAudioStream

Hierarchy

  • PluginMediaStream<PluginAudioTrack>
    • PluginAudioStream

Implements

  • IStream
  • IInternalStream
  • IMediaStream
  • IInternalMediaStream
  • IAudioStream
  • IInternalAudioStream

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PluginAudioStream(external: IExternalAudioStream, localTrack: PluginAudioTrack, remoteTrack: PluginAudioTrack): PluginAudioStream

  • Parameters

    • external: IExternalAudioStream
    • localTrack: PluginAudioTrack
    • remoteTrack: PluginAudioTrack

    Returns PluginAudioStream

Properties

Private _axo

_axo: AudioStreamActiveXObject
internal

Private _external

_external: IExternalAudioStream
internal

Private _onDirectionChangeValues

_onDirectionChangeValues: IAction0[] = []
internal

Private _onReceiveDtmfToneChangeValues

_onReceiveDtmfToneChangeValues: IAction1<Tone>[] = []
internal

Private _onReceiveDtmfToneValues

_onReceiveDtmfToneValues: IAction1<Tone>[] = []
internal

Private _onSendDtmfToneChangeValues

_onSendDtmfToneChangeValues: IAction1<Tone>[] = []
internal

Private _onSendDtmfToneValues

_onSendDtmfToneValues: IAction1<Tone>[] = []
internal

Methods

Protected _getAxo

  • _getAxo(): AudioStreamActiveXObject
  • internal

    Returns AudioStreamActiveXObject

_getExternal

  • _getExternal(): IExternalAudioStream
  • internal

    Returns IExternalAudioStream

addOnDirectionChange

  • addOnDirectionChange(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

addOnReceiveDtmfTone

  • addOnReceiveDtmfTone(value: IAction1<Tone>): void

  • Parameters

    • value: IAction1<Tone>

    Returns void

addOnReceiveDtmfToneChange

  • addOnReceiveDtmfToneChange(value: IAction1<Tone>): void

  • Parameters

    • value: IAction1<Tone>

    Returns void

addOnSendDtmfTone

  • addOnSendDtmfTone(value: IAction1<Tone>): void

  • Parameters

    • value: IAction1<Tone>

    Returns void

addOnSendDtmfToneChange

  • addOnSendDtmfToneChange(value: IAction1<Tone>): void

  • Parameters

    • value: IAction1<Tone>

    Returns 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.

getHandle

  • getHandle(): number

  • Returns number

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

  • Returns number

getLocalDirection

  • getLocalDirection(): StreamDirection

  • Returns StreamDirection

getLocalReceive

  • getLocalReceive(): boolean

  • Returns boolean

getLocalSend

  • getLocalSend(): boolean

  • Returns boolean

getLocalTrack

  • getLocalTrack(): PluginAudioTrack

  • Returns PluginAudioTrack

getMuted

  • getMuted(): boolean

  • Returns boolean

getRemoteBandwidth

  • getRemoteBandwidth(): number

  • Returns number

getRemoteDirection

  • getRemoteDirection(): StreamDirection

  • Returns StreamDirection

getRemoteReceive

  • getRemoteReceive(): boolean

  • Returns boolean

getRemoteSend

  • getRemoteSend(): boolean

  • Returns boolean

getRemoteTrack

  • getRemoteTrack(): PluginAudioTrack

  • Returns PluginAudioTrack

getSerialized

  • getSerialized(): string

getTag

  • getTag(): string

  • Returns string

getType

  • getType(): StreamType

  • Returns StreamType

getTypeString

  • getTypeString(): string

  • Returns string

insertDtmfTone

  • insertDtmfTone(dtmfTone: Tone): boolean

  • Parameters

    • dtmfTone: Tone

    Returns boolean

insertDtmfTones

  • insertDtmfTones(dtmfTones: Tone[]): boolean

  • Parameters

    • dtmfTones: Tone[]

    Returns boolean

removeOnDirectionChange

  • removeOnDirectionChange(value: IAction0): void

  • Parameters

    • value: IAction0

    Returns void

removeOnReceiveDtmfTone

  • removeOnReceiveDtmfTone(value: IAction1<Tone>): void

  • Parameters

    • value: IAction1<Tone>

    Returns void

removeOnReceiveDtmfToneChange

  • removeOnReceiveDtmfToneChange(value: IAction1<Tone>): void

  • Parameters

    • value: IAction1<Tone>

    Returns void

removeOnSendDtmfTone

  • removeOnSendDtmfTone(value: IAction1<Tone>): void

  • Parameters

    • value: IAction1<Tone>

    Returns void

removeOnSendDtmfToneChange

  • removeOnSendDtmfToneChange(value: IAction1<Tone>): void

  • Parameters

    • value: IAction1<Tone>

    Returns 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

  • Parameters

    • value: number

    Returns void

setLocalDirection

  • setLocalDirection(value: StreamDirection): void

  • Parameters

    • value: StreamDirection

    Returns void

setLocalReceive

  • setLocalReceive(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

setLocalSend

  • setLocalSend(value: boolean): void

  • Parameters

    • value: 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.