Class AudioMessage

constructor

• new AudioMessage(properties?): AudioMessage

• Constructs a new AudioMessage.

  Parameters

  • Optional properties: IAudioMessage

    Properties to set

  Returns AudioMessage

Optional accessibilityLabel

Optional backgroundArgb

Optional contextInfo

Optional directPath

Optional fileEncSha256

Optional fileLength

Optional fileSha256

Optional mediaKey

Optional mediaKeyTimestamp

Optional mimetype

Optional ptt

Optional seconds

Optional streamingSidecar

Optional url

Optional viewOnce

Optional waveform

toJSON

• toJSON(): {
      [k: string]: any;
  }

• Converts this AudioMessage to JSON.

  Returns {
      [k: string]: any;
  }

  JSON object

  • [k: string]: any

Static create

• create(properties?): AudioMessage

• Creates a new AudioMessage instance using the specified properties.

  Parameters

  • Optional properties: IAudioMessage

    Properties to set

  Returns AudioMessage

  AudioMessage instance

Static decode

• decode(reader, length?): AudioMessage

• 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

Static decodeDelimited

• decodeDelimited(reader): AudioMessage

• 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

Static encode

• encode(message, writer?): Writer

• 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

Static encodeDelimited

• encodeDelimited(message, 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

Static fromObject

• fromObject(object): AudioMessage

• 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

Static getTypeUrl

• getTypeUrl(typeUrlPrefix?): string

• Gets the default type url for AudioMessage

  Parameters

  • Optional typeUrlPrefix: string

    your custom typeUrlPrefix(default "type.googleapis.com")

  Returns string

  The default type url

Static toObject

• toObject(message, options?): {
      [k: string]: any;
  }

• 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

Static verify

• verify(message): null | string

• 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