Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AudioMessage

Represents an AudioMessage.

Hierarchy

  • AudioMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional contextInfo

contextInfo: IContextInfo

AudioMessage contextInfo.

directPath

directPath: string

AudioMessage directPath.

fileEncSha256

fileEncSha256: Uint8Array

AudioMessage fileEncSha256.

fileLength

fileLength: number | Long

AudioMessage fileLength.

fileSha256

fileSha256: Uint8Array

AudioMessage fileSha256.

mediaKey

mediaKey: Uint8Array

AudioMessage mediaKey.

mediaKeyTimestamp

mediaKeyTimestamp: number | Long

AudioMessage mediaKeyTimestamp.

mimetype

mimetype: string

AudioMessage mimetype.

ptt

ptt: boolean

AudioMessage ptt.

seconds

seconds: number

AudioMessage seconds.

streamingSidecar

streamingSidecar: Uint8Array

AudioMessage streamingSidecar.

url

url: string

AudioMessage url.

waveform

waveform: Uint8Array

AudioMessage waveform.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

  • decode(reader: Uint8Array | Reader, length?: number): AudioMessage

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns AudioMessage

    AudioMessage

Static decodeDelimited

  • decodeDelimited(reader: Uint8Array | Reader): AudioMessage

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns AudioMessage

    AudioMessage

Static encode

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

    Parameters

    • message: IAudioMessage

      AudioMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message: IAudioMessage, writer?: 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

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns AudioMessage

    AudioMessage

Static toObject

  • toObject(message: AudioMessage, options?: IConversionOptions): {}

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

    Parameters

    • message: AudioMessage

      AudioMessage

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies an AudioMessage message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc