Search Results for

    / fm / liveswitch / IExternalVideoStream

    Interface: IExternalVideoStream

    fm.liveswitch.IExternalVideoStream

    Hierarchy

    • IVideoStream

    • IExternal<IInternalVideoStream>

      ↳ IExternalVideoStream

    Implemented by

    • VideoStream

    Table of contents

    Methods

    • addOnDirectionChange
    • addOnDiscardBitrateNotification
    • addOnDiscardBitrateRequest
    • addOnDiscardKeyFrameRequest
    • addOnLocalEncodingDisabled
    • addOnLocalEncodingEnabled
    • addOnStateChange
    • changeDirection
    • getCachedLocalDirection
    • getCodecDisabled
    • getControlTransportInfo
    • getDirection
    • getExternalId
    • getH264Disabled
    • getH265Disabled
    • getId
    • getInfo
    • getInputMuted
    • getLabel
    • getLocalBandwidth
    • getLocalCanonicalName
    • getLocalDirection
    • getLocalReceive
    • getLocalSend
    • getMaxReceiveBitrate
    • getMaxSendBitrate
    • getMediaDescriptionId
    • getOutputMuted
    • getPreferredCodecs
    • getRemoteBandwidth
    • getRemoteCanonicalName
    • getRemoteDirection
    • getRemoteEncoding
    • getRemoteMuted
    • getRemoteReceive
    • getRemoteRequestedDeactivation
    • getRemoteSend
    • getSimulcastMode
    • getState
    • getTag
    • getTransportInfo
    • getType
    • getVp8Disabled
    • getVp9Disabled
    • raiseBitrateNotification
    • raiseBitrateRequest
    • raiseKeyFrameRequest
    • removeOnDirectionChange
    • removeOnDiscardBitrateNotification
    • removeOnDiscardBitrateRequest
    • removeOnDiscardKeyFrameRequest
    • removeOnLocalEncodingDisabled
    • removeOnLocalEncodingEnabled
    • removeOnStateChange
    • setCodecDisabled
    • setExternalId
    • setH264Disabled
    • setH265Disabled
    • setInputMuted
    • setLocalBandwidth
    • setLocalDirection
    • setLocalReceive
    • setLocalSend
    • setMaxReceiveBitrate
    • setMaxSendBitrate
    • setOutputMuted
    • setPreferredCodecs
    • setRemoteEncoding
    • setRemoteMuted
    • setSimulcastMode
    • setTag
    • setVp8Disabled
    • setVp9Disabled

    Methods

    addOnDirectionChange

    ▸ addOnDirectionChange(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IStream.ts:9


    addOnDiscardBitrateNotification

    ▸ addOnDiscardBitrateNotification(value: IAction1<BitrateNotification>): void

    Parameters:

    Name Type
    value IAction1<BitrateNotification>

    Returns: void

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IMediaStream.ts:9


    addOnDiscardBitrateRequest

    ▸ addOnDiscardBitrateRequest(value: IAction1<BitrateRequest>): void

    Parameters:

    Name Type
    value IAction1<BitrateRequest>

    Returns: void

    Inherited from: IVideoStream

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


    addOnDiscardKeyFrameRequest

    ▸ addOnDiscardKeyFrameRequest(value: IAction1<number[]>): void

    Parameters:

    Name Type
    value IAction1<number[]>

    Returns: void

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IVideoStream.ts:9


    addOnLocalEncodingDisabled

    ▸ addOnLocalEncodingDisabled(value: IAction1<EncodingInfo>): void

    Parameters:

    Name Type
    value IAction1<EncodingInfo>

    Returns: void

    Inherited from: IVideoStream

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


    addOnLocalEncodingEnabled

    ▸ addOnLocalEncodingEnabled(value: IAction1<EncodingInfo>): void

    Parameters:

    Name Type
    value IAction1<EncodingInfo>

    Returns: void

    Inherited from: IVideoStream

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


    addOnStateChange

    ▸ addOnStateChange(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Inherited from: IVideoStream

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


    changeDirection

    ▸ changeDirection(newDirection: StreamDirection): Error

    Parameters:

    Name Type
    newDirection StreamDirection

    Returns: Error

    Inherited from: IVideoStream

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


    getCachedLocalDirection

    ▸ getCachedLocalDirection(): StreamDirection

    Returns: StreamDirection

    Inherited from: IVideoStream

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


    getCodecDisabled

    ▸ getCodecDisabled(name: string): boolean

    Parameters:

    Name Type
    name string

    Returns: boolean

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IMediaStream.ts:14


    getControlTransportInfo

    ▸ getControlTransportInfo(): TransportInfo

    Returns: TransportInfo

    Inherited from: IVideoStream

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


    getDirection

    ▸ getDirection(): StreamDirection

    Returns: StreamDirection

    Inherited from: IVideoStream

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


    getExternalId

    ▸ getExternalId(): string

    Returns: string

    Inherited from: IVideoStream

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


    getH264Disabled

    ▸ getH264Disabled(): boolean

    Returns: boolean

    Inherited from: IVideoStream

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


    getH265Disabled

    ▸ getH265Disabled(): boolean

    Returns: boolean

    Inherited from: IVideoStream

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


    getId

    ▸ getId(): string

    Returns: string

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IStream.ts:14


    getInfo

    ▸ getInfo(): MediaStreamInfo

    Returns: MediaStreamInfo

    Inherited from: IVideoStream

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


    getInputMuted

    ▸ getInputMuted(): boolean

    Returns: boolean

    Inherited from: IVideoStream

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


    getLabel

    ▸ getLabel(): string

    Returns: string

    Inherited from: IVideoStream

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


    getLocalBandwidth

    ▸ getLocalBandwidth(): number

    Returns: number

    Inherited from: IVideoStream

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


    getLocalCanonicalName

    ▸ getLocalCanonicalName(): string

    Returns: string

    Inherited from: IVideoStream

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


    getLocalDirection

    ▸ getLocalDirection(): StreamDirection

    Returns: StreamDirection

    Inherited from: IVideoStream

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


    getLocalReceive

    ▸ getLocalReceive(): boolean

    Returns: boolean

    Inherited from: IVideoStream

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


    getLocalSend

    ▸ getLocalSend(): boolean

    Returns: boolean

    Inherited from: IVideoStream

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


    getMaxReceiveBitrate

    ▸ getMaxReceiveBitrate(): number

    Returns: number

    Inherited from: IVideoStream

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


    getMaxSendBitrate

    ▸ getMaxSendBitrate(): number

    Returns: number

    Inherited from: IVideoStream

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


    getMediaDescriptionId

    ▸ getMediaDescriptionId(): string

    Returns: string

    Inherited from: IVideoStream

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


    getOutputMuted

    ▸ getOutputMuted(): boolean

    Returns: boolean

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IMediaStream.ts:22


    getPreferredCodecs

    ▸ getPreferredCodecs(): string[]

    Returns: string[]

    Inherited from: IVideoStream

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


    getRemoteBandwidth

    ▸ getRemoteBandwidth(): number

    Returns: number

    Inherited from: IVideoStream

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


    getRemoteCanonicalName

    ▸ getRemoteCanonicalName(): string

    Returns: string

    Inherited from: IVideoStream

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


    getRemoteDirection

    ▸ getRemoteDirection(): StreamDirection

    Returns: StreamDirection

    Inherited from: IVideoStream

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


    getRemoteEncoding

    ▸ getRemoteEncoding(): EncodingInfo

    Returns: EncodingInfo

    Inherited from: IVideoStream

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


    getRemoteMuted

    ▸ getRemoteMuted(): boolean

    Returns: boolean

    Inherited from: IVideoStream

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


    getRemoteReceive

    ▸ getRemoteReceive(): boolean

    Returns: boolean

    Inherited from: IVideoStream

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


    getRemoteRequestedDeactivation

    ▸ getRemoteRequestedDeactivation(): boolean

    Returns: boolean

    Inherited from: IVideoStream

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


    getRemoteSend

    ▸ getRemoteSend(): boolean

    Returns: boolean

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IStream.ts:22


    getSimulcastMode

    ▸ getSimulcastMode(): SimulcastMode

    Returns: SimulcastMode

    Inherited from: IVideoStream

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


    getState

    ▸ getState(): StreamState

    Returns: StreamState

    Inherited from: IVideoStream

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


    getTag

    ▸ getTag(): string

    Returns: string

    Inherited from: IVideoStream

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


    getTransportInfo

    ▸ getTransportInfo(): TransportInfo

    Returns: TransportInfo

    Inherited from: IVideoStream

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


    getType

    ▸ getType(): StreamType

    Returns: StreamType

    Inherited from: IVideoStream

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


    getVp8Disabled

    ▸ getVp8Disabled(): boolean

    Returns: boolean

    Inherited from: IVideoStream

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


    getVp9Disabled

    ▸ getVp9Disabled(): boolean

    Returns: boolean

    Inherited from: IVideoStream

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


    raiseBitrateNotification

    ▸ raiseBitrateNotification(bitrateNotification: BitrateNotification): boolean

    Parameters:

    Name Type
    bitrateNotification BitrateNotification

    Returns: boolean

    Inherited from: IVideoStream

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


    raiseBitrateRequest

    ▸ raiseBitrateRequest(bitrateRequest: BitrateRequest): boolean

    Parameters:

    Name Type
    bitrateRequest BitrateRequest

    Returns: boolean

    Inherited from: IVideoStream

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


    raiseKeyFrameRequest

    ▸ raiseKeyFrameRequest(synchronizationSources: number[]): void

    Parameters:

    Name Type
    synchronizationSources number[]

    Returns: void

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IVideoStream.ts:14


    removeOnDirectionChange

    ▸ removeOnDirectionChange(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Inherited from: IVideoStream

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


    removeOnDiscardBitrateNotification

    ▸ removeOnDiscardBitrateNotification(value: IAction1<BitrateNotification>): void

    Parameters:

    Name Type
    value IAction1<BitrateNotification>

    Returns: void

    Inherited from: IVideoStream

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


    removeOnDiscardBitrateRequest

    ▸ removeOnDiscardBitrateRequest(value: IAction1<BitrateRequest>): void

    Parameters:

    Name Type
    value IAction1<BitrateRequest>

    Returns: void

    Inherited from: IVideoStream

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


    removeOnDiscardKeyFrameRequest

    ▸ removeOnDiscardKeyFrameRequest(value: IAction1<number[]>): void

    Parameters:

    Name Type
    value IAction1<number[]>

    Returns: void

    Inherited from: IVideoStream

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


    removeOnLocalEncodingDisabled

    ▸ removeOnLocalEncodingDisabled(value: IAction1<EncodingInfo>): void

    Parameters:

    Name Type
    value IAction1<EncodingInfo>

    Returns: void

    Inherited from: IVideoStream

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


    removeOnLocalEncodingEnabled

    ▸ removeOnLocalEncodingEnabled(value: IAction1<EncodingInfo>): void

    Parameters:

    Name Type
    value IAction1<EncodingInfo>

    Returns: void

    Inherited from: IVideoStream

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


    removeOnStateChange

    ▸ removeOnStateChange(value: IAction0): void

    Parameters:

    Name Type
    value IAction0

    Returns: void

    Inherited from: IVideoStream

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


    setCodecDisabled

    ▸ setCodecDisabled(name: string, disabled: boolean): void

    Parameters:

    Name Type
    name string
    disabled boolean

    Returns: void

    Inherited from: IVideoStream

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


    setExternalId

    ▸ setExternalId(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Inherited from: IVideoStream

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


    setH264Disabled

    ▸ setH264Disabled(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: IVideoStream

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


    setH265Disabled

    ▸ setH265Disabled(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: IVideoStream

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


    setInputMuted

    ▸ setInputMuted(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: IVideoStream

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


    setLocalBandwidth

    ▸ setLocalBandwidth(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Inherited from: IVideoStream

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


    setLocalDirection

    ▸ setLocalDirection(value: StreamDirection): void

    Parameters:

    Name Type
    value StreamDirection

    Returns: void

    Inherited from: IVideoStream

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


    setLocalReceive

    ▸ setLocalReceive(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: IVideoStream

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


    setLocalSend

    ▸ setLocalSend(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: IVideoStream

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


    setMaxReceiveBitrate

    ▸ setMaxReceiveBitrate(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Inherited from: IVideoStream

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


    setMaxSendBitrate

    ▸ setMaxSendBitrate(value: number): void

    Parameters:

    Name Type
    value number

    Returns: void

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IMediaStream.ts:40


    setOutputMuted

    ▸ setOutputMuted(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IMediaStream.ts:41


    setPreferredCodecs

    ▸ setPreferredCodecs(value: string[]): void

    Parameters:

    Name Type
    value string[]

    Returns: void

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IMediaStream.ts:42


    setRemoteEncoding

    ▸ setRemoteEncoding(value: EncodingInfo): void

    Parameters:

    Name Type
    value EncodingInfo

    Returns: void

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IMediaStream.ts:43


    setRemoteMuted

    ▸ setRemoteMuted(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IMediaStream.ts:44


    setSimulcastMode

    ▸ setSimulcastMode(value: SimulcastMode): void

    Parameters:

    Name Type
    value SimulcastMode

    Returns: void

    Inherited from: IVideoStream

    Defined in: Generated/TypeScript/fm.liveswitch/IMediaStream.ts:45


    setTag

    ▸ setTag(value: string): void

    Parameters:

    Name Type
    value string

    Returns: void

    Inherited from: IVideoStream

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


    setVp8Disabled

    ▸ setVp8Disabled(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: IVideoStream

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


    setVp9Disabled

    ▸ setVp9Disabled(value: boolean): void

    Parameters:

    Name Type
    value boolean

    Returns: void

    Inherited from: IVideoStream

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

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