Search Results for

    / fm / liveswitch / PluginStream

    Class: PluginStream

    fm.liveswitch.PluginStream

    Hierarchy

    • Dynamic

      ↳ PluginStream

      ↳↳ PluginMediaStream

      ↳↳ PluginDataStream

    Implements

    • IStream
    • IInternalStream

    Table of contents

    Constructors

    • constructor

    Methods

    • addOnDirectionChange
    • addOnStateChange
    • changeDirection
    • getDirection
    • getDynamicProperties
    • getDynamicValue
    • getExternalId
    • getHandle
    • getId
    • getLabel
    • getLocalDirection
    • getLocalReceive
    • getLocalSend
    • getMediaDescriptionId
    • getRemoteDirection
    • getRemoteReceive
    • getRemoteSend
    • getState
    • getTag
    • getTransportInfo
    • getType
    • getTypeString
    • removeOnDirectionChange
    • removeOnStateChange
    • setDynamicValue
    • setExternalId
    • setLocalDirection
    • setLocalReceive
    • setLocalSend
    • setTag
    • unsetDynamicValue

    Constructors

    constructor

    + new PluginStream(): PluginStream

    Returns: PluginStream

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:17

    Methods

    addOnDirectionChange

    ▸ AbstractaddOnDirectionChange(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:24


    addOnStateChange

    ▸ AbstractaddOnStateChange(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:12


    changeDirection

    ▸ AbstractchangeDirection(newDirection: StreamDirection): Error

    Parameters:

    Name Type
    newDirection StreamDirection

    Returns: Error

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:26


    getDirection

    ▸ AbstractgetDirection(): StreamDirection

    Returns: StreamDirection

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:27


    getDynamicProperties

    ▸ getDynamicProperties(): Hash<string, Object>

    Gets all dynamic properties on this instance.

    Returns: Hash<string, Object>

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:37


    getDynamicValue

    ▸ getDynamicValue(key: string): Object

    Gets a property value from the local cache.

    Parameters:

    Name Type Description
    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.

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:58


    getExternalId

    ▸ AbstractgetExternalId(): string

    Returns: string

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:29


    getHandle

    ▸ AbstractgetHandle(): number

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:23


    getId

    ▸ AbstractgetId(): string

    Returns: string

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:28


    getLabel

    ▸ AbstractgetLabel(): string

    Returns: string

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:31


    getLocalDirection

    ▸ AbstractgetLocalDirection(): StreamDirection

    Returns: StreamDirection

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:32


    getLocalReceive

    ▸ AbstractgetLocalReceive(): boolean

    Returns: boolean

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:15


    getLocalSend

    ▸ AbstractgetLocalSend(): boolean

    Returns: boolean

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:17


    getMediaDescriptionId

    ▸ AbstractgetMediaDescriptionId(): string

    Returns: string

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:33


    getRemoteDirection

    ▸ AbstractgetRemoteDirection(): StreamDirection

    Returns: StreamDirection

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:21


    getRemoteReceive

    ▸ AbstractgetRemoteReceive(): boolean

    Returns: boolean

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:20


    getRemoteSend

    ▸ AbstractgetRemoteSend(): boolean

    Returns: boolean

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:19


    getState

    ▸ AbstractgetState(): StreamState

    Returns: StreamState

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:11


    getTag

    ▸ AbstractgetTag(): string

    Returns: string

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:34


    getTransportInfo

    ▸ AbstractgetTransportInfo(): TransportInfo

    Returns: TransportInfo

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:38


    getType

    ▸ AbstractgetType(): StreamType

    Returns: StreamType

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:35


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:4


    removeOnDirectionChange

    ▸ AbstractremoveOnDirectionChange(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:25


    removeOnStateChange

    ▸ AbstractremoveOnStateChange(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:13


    setDynamicValue

    ▸ setDynamicValue(key: string, value: Object): void

    Sets a property value in the local cache.

    Parameters:

    Name Type Description
    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

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:95


    setExternalId

    ▸ AbstractsetExternalId(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:30


    setLocalDirection

    ▸ AbstractsetLocalDirection(value: StreamDirection): void

    Parameters:

    Name Type
    value StreamDirection

    Returns: void

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:36


    setLocalReceive

    ▸ AbstractsetLocalReceive(localReceiveEnabled: boolean): void

    Parameters:

    Name Type
    localReceiveEnabled boolean

    Returns: void

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:16


    setLocalSend

    ▸ AbstractsetLocalSend(localSendEnabled: boolean): void

    Parameters:

    Name Type
    localSendEnabled boolean

    Returns: void

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:18


    setTag

    ▸ AbstractsetTag(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Implementation of: IInternalStream

    Defined in: Generated/TypeScript/fm.liveswitch/PluginStream.ts:37


    unsetDynamicValue

    ▸ unsetDynamicValue(key: string): boolean

    Removes a property value from the local cache. Returns true if the value was removed and returns false otherwise.

    Parameters:

    Name Type Description
    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.

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:122

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.15.0