Class AudioMessage

Represents an AudioMessage.

Hierarchy

  • AudioMessage

Implements

Constructors

Properties

backgroundArgb: number

AudioMessage backgroundArgb.

contextInfo?: null | IContextInfo

AudioMessage contextInfo.

directPath: string

AudioMessage directPath.

fileEncSha256: Uint8Array

AudioMessage fileEncSha256.

fileLength: number | Long

AudioMessage fileLength.

fileSha256: Uint8Array

AudioMessage fileSha256.

mediaKey: Uint8Array

AudioMessage mediaKey.

mediaKeyTimestamp: number | Long

AudioMessage mediaKeyTimestamp.

mimetype: string

AudioMessage mimetype.

ptt: boolean

AudioMessage ptt.

seconds: number

AudioMessage seconds.

streamingSidecar: Uint8Array

AudioMessage streamingSidecar.

url: string

AudioMessage url.

viewOnce: boolean

AudioMessage viewOnce.

waveform: Uint8Array

AudioMessage waveform.

Methods

  • Converts this AudioMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Decodes an AudioMessage message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns AudioMessage

    AudioMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Decodes an AudioMessage message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns AudioMessage

    AudioMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Encodes the specified AudioMessage message. Does not implicitly verify messages.

    Parameters

    • message: IAudioMessage

      AudioMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Encodes the specified AudioMessage message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IAudioMessage

      AudioMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Creates an AudioMessage message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: {
          [k: string]: any;
      }

      Plain object

      • [k: string]: any

    Returns AudioMessage

    AudioMessage

  • Creates a plain object from an AudioMessage message. Also converts values to other types if specified.

    Parameters

    • message: AudioMessage

      AudioMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies an AudioMessage message.

    Parameters

    • message: {
          [k: string]: any;
      }

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc