Search Results for

    / fm / liveswitch / MediaSinkBase

    Class: MediaSinkBase

    fm.liveswitch.MediaSinkBase

    Media sink base properties/methods.

    Hierarchy

    • Dynamic

      ↳ MediaSinkBase

    Table of contents

    Constructors

    • constructor

    Methods

    • getDynamicProperties
    • getDynamicValue
    • getExternalId
    • getId
    • getLogContext
    • getTag
    • getTypeString
    • setDynamicValue
    • setExternalId
    • setLogContext
    • setTag
    • unsetDynamicValue
    • updateLogContext

    Constructors

    constructor

    + new MediaSinkBase(): MediaSinkBase

    Returns: MediaSinkBase

    Inherited from: Dynamic

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

    Methods

    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:61


    getExternalId

    ▸ getExternalId(): string

    Gets the external identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkBase.ts:39


    getId

    ▸ getId(): string

    Gets the identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkBase.ts:51


    getLogContext

    ▸ getLogContext(): LogContext

    Gets the log context.

    Returns: LogContext

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkBase.ts:63


    getTag

    ▸ getTag(): string

    Gets optional data to associate with this instance.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkBase.ts:75


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkBase.ts:10


    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:98


    setExternalId

    ▸ setExternalId(value: string): void

    Sets the external identifier.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkBase.ts:87


    setLogContext

    ▸ ProtectedsetLogContext(value: LogContext): void

    Sets the log context.

    Parameters:

    Name Type
    value LogContext

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkBase.ts:99


    setTag

    ▸ setTag(value: string): void

    Sets optional data to associate with this instance.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkBase.ts:111


    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:125


    updateLogContext

    ▸ updateLogContext(context: LogContext): void

    Updates the log context.

    Parameters:

    Name Type
    context LogContext

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSinkBase.ts:124

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