Search Results for

    / fm / liveswitch / MediaSenderReport

    Class: MediaSenderReport

    fm.liveswitch.MediaSenderReport

    Media sender report.

    Hierarchy

    • MediaComponentReport

      ↳ MediaSenderReport

    Table of contents

    Constructors

    • constructor

    Methods

    • deserializeProperties
    • getBytesSent
    • getFirCount
    • getLrrCount
    • getNackCount
    • getPacketsSent
    • getPliCount
    • getRoundTripTime
    • getSliCount
    • getTypeString
    • serializeProperties
    • setBytesSent
    • setFirCount
    • setLrrCount
    • setNackCount
    • setPacketsSent
    • setPliCount
    • setRoundTripTime
    • setSliCount
    • toJson
    • fromJson
    • fromJsonArray
    • processArray
    • processBoolean
    • processBooleanArray
    • processDouble
    • processFloat
    • processFloatArray
    • processInteger
    • processIntegerArray
    • processLong
    • processLongArray
    • processObject
    • processShort
    • processShortArray
    • processString
    • toJson
    • toJsonArray

    Constructors

    constructor

    + new MediaSenderReport(): MediaSenderReport

    Initializes a new instance of the [[fm.liveswitch.mediaSenderReport]] class.

    Returns: MediaSenderReport

    Inherited from: MediaComponentReport

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

    + new MediaSenderReport(stats: MediaSenderStats, lastStats: MediaSenderStats): MediaSenderReport

    Parameters:

    Name Type
    stats MediaSenderStats
    lastStats MediaSenderStats

    Returns: MediaSenderReport

    Inherited from: MediaComponentReport

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

    Methods

    deserializeProperties

    ▸ ProtecteddeserializeProperties(key: string, valueJson: string): void

    Deserializes the properties.

    Parameters:

    Name Type Description
    key string The key.
    valueJson string The value in JSON format.

    Returns: void

    Overrides: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:119


    getBytesSent

    ▸ getBytesSent(): number

    Gets the number of bytes sent.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:145


    getFirCount

    ▸ getFirCount(): number

    Gets the number of full intra refresh (FIR) messages sent.

    Returns: number

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentReport.ts:93


    getLrrCount

    ▸ getLrrCount(): number

    Gets the number of layer refresh request (LRR) messages sent.

    Returns: number

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentReport.ts:105


    getNackCount

    ▸ getNackCount(): number

    Gets the number of negative-acknowledgement (NACK) messages sent.

    Returns: number

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentReport.ts:117


    getPacketsSent

    ▸ getPacketsSent(): number

    Gets the number of packets sent.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:157


    getPliCount

    ▸ getPliCount(): number

    Gets the number of picture loss indication (PLI) messages sent.

    Returns: number

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentReport.ts:129


    getRoundTripTime

    ▸ getRoundTripTime(): number

    Gets the round-trip-time in milliseconds.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:169


    getSliCount

    ▸ getSliCount(): number

    Gets the number of slice loss indication (SLI) messages sent.

    Returns: number

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentReport.ts:141


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: MediaComponentReport

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


    serializeProperties

    ▸ ProtectedserializeProperties(jsonObject: Hash<string, string>): void

    Serializes the properties.

    Parameters:

    Name Type Description
    jsonObject Hash<string, string> The JSON object.

    Returns: void

    Overrides: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:182


    setBytesSent

    ▸ setBytesSent(value: number): void

    Sets the number of bytes sent.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:203


    setFirCount

    ▸ setFirCount(value: number): void

    Sets the number of full intra refresh (FIR) messages sent.

    Parameters:

    Name Type
    value number

    Returns: void

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentReport.ts:181


    setLrrCount

    ▸ setLrrCount(value: number): void

    Sets the number of layer refresh request (LRR) messages sent.

    Parameters:

    Name Type
    value number

    Returns: void

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentReport.ts:193


    setNackCount

    ▸ setNackCount(value: number): void

    Sets the number of negative-acknowledgement (NACK) messages sent.

    Parameters:

    Name Type
    value number

    Returns: void

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentReport.ts:205


    setPacketsSent

    ▸ setPacketsSent(value: number): void

    Sets the number of packets sent.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:215


    setPliCount

    ▸ setPliCount(value: number): void

    Sets the number of picture loss indication (PLI) messages sent.

    Parameters:

    Name Type
    value number

    Returns: void

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentReport.ts:217


    setRoundTripTime

    ▸ setRoundTripTime(value: number): void

    Sets the round-trip-time in milliseconds.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:227


    setSliCount

    ▸ setSliCount(value: number): void

    Sets the number of slice loss indication (SLI) messages sent.

    Parameters:

    Name Type
    value number

    Returns: void

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/MediaComponentReport.ts:229


    toJson

    ▸ toJson(): string

    Serializes this instance to JSON.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:239


    fromJson

    ▸ StaticfromJson(mediaSenderReportJson: string): MediaSenderReport

    Deserializes an instance from JSON.

    Parameters:

    Name Type Description
    mediaSenderReportJson string The serialized JSON.

    Returns: MediaSenderReport

    The deserialized instance.

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:53


    fromJsonArray

    ▸ StaticfromJsonArray(mediaSenderReportsJson: string): MediaSenderReport[]

    Deserializes an array from JSON.

    Parameters:

    Name Type Description
    mediaSenderReportsJson string The serialized JSON.

    Returns: MediaSenderReport[]

    The deserialized array.

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:71


    processArray

    ▸ StaticprocessArray<T>(newValues: T[], oldValues: T[]): T[]

    Processes an array for a report.

    Type parameters:

    Name Type
    T IEquivalent<T, T>

    Parameters:

    Name Type Description
    newValues T[] The new values.
    oldValues T[] The old values.

    Returns: T[]

    The new values, if the new values are not equivalent to the old values; otherwise null.

    Inherited from: MediaComponentReport

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


    processBoolean

    ▸ StaticprocessBoolean(newValue: boolean, oldValue: boolean): boolean

    Processes a boolean for a report.

    Parameters:

    Name Type Description
    newValue boolean The new value.
    oldValue boolean The old value.

    Returns: boolean

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:57


    processBooleanArray

    ▸ StaticprocessBooleanArray(newValues: boolean[], oldValues: boolean[]): boolean[]

    Processes a boolean array for a report.

    Parameters:

    Name Type Description
    newValues boolean[] The new values.
    oldValues boolean[] The old values.

    Returns: boolean[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:72


    processDouble

    ▸ StaticprocessDouble(newValue: number, oldValue: number): number

    Processes a double for a report.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:98


    processFloat

    ▸ StaticprocessFloat(newValue: number, oldValue: number): number

    Processes a float for a report.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:113


    processFloatArray

    ▸ StaticprocessFloatArray(newValues: number[], oldValues: number[]): number[]

    Processes a float array for a report.

    Parameters:

    Name Type Description
    newValues number[] The new values.
    oldValues number[] The old values.

    Returns: number[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:128


    processInteger

    ▸ StaticprocessInteger(newValue: number, oldValue: number): number

    Processes an integer for a report.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:154


    processIntegerArray

    ▸ StaticprocessIntegerArray(newValues: number[], oldValues: number[]): number[]

    Processes a integer array for a report.

    Parameters:

    Name Type Description
    newValues number[] The new values.
    oldValues number[] The old values.

    Returns: number[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:171


    processLong

    ▸ StaticprocessLong(newValue: number, oldValue: number): number

    Processes a long for a report.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:197


    processLongArray

    ▸ StaticprocessLongArray(newValues: number[], oldValues: number[]): number[]

    Processes a long array for a report.

    Parameters:

    Name Type Description
    newValues number[] The new values.
    oldValues number[] The old values.

    Returns: number[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:214


    processObject

    ▸ StaticprocessObject<T>(newValue: T, oldValue: T): T

    Processes an array for a report.

    Type parameters:

    Name Type
    T Object & IEquivalent<T, T>

    Parameters:

    Name Type Description
    newValue T The new value.
    oldValue T The old value.

    Returns: T

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:240


    processShort

    ▸ StaticprocessShort(newValue: number, oldValue: number): number

    Processes a short for a report.

    Parameters:

    Name Type Description
    newValue number The new value.
    oldValue number The old value.

    Returns: number

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:261


    processShortArray

    ▸ StaticprocessShortArray(newValues: number[], oldValues: number[]): number[]

    Processes a short array for a report.

    Parameters:

    Name Type Description
    newValues number[] The new values.
    oldValues number[] The old values.

    Returns: number[]

    The new values, if the new values do not equal the old values; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:278


    processString

    ▸ StaticprocessString(newValue: string, oldValue: string): string

    Processes a string for a report.

    Parameters:

    Name Type Description
    newValue string The new value.
    oldValue string The old value.

    Returns: string

    The new value, if the new value does not equal the old value; otherwise null.

    Inherited from: MediaComponentReport

    Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:304


    toJson

    ▸ StatictoJson(mediaSenderReport: MediaSenderReport): string

    Serializes an instance to JSON.

    Parameters:

    Name Type Description
    mediaSenderReport MediaSenderReport The instance to serialize.

    Returns: string

    The serialized JSON.

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:89


    toJsonArray

    ▸ StatictoJsonArray(mediaSenderReports: MediaSenderReport[]): string

    Serializes an array to JSON.

    Parameters:

    Name Type Description
    mediaSenderReports MediaSenderReport[] The array to serialize.

    Returns: string

    The serialized JSON.

    Defined in: Generated/TypeScript/fm.liveswitch/MediaSenderReport.ts:105

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