Class: RawAudioFormat

Guacamole.RawAudioFormat(templatenon-null)

new RawAudioFormat(templatenon-null)

A description of the format of raw PCM audio, such as that used by Guacamole.RawAudioPlayer and Guacamole.RawAudioRecorder. This object describes the number of bytes per sample, the number of channels, and the overall sample rate.
Parameters:
Name Type Description
template Guacamole.RawAudioFormat | object The object whose properties should be copied into the corresponding properties of the new Guacamole.RawAudioFormat.
Source:

Members

(non-null) bytesPerSample :number

The number of bytes in each sample of audio data. This value is independent of the number of channels.
Type:
  • number
Source:

(non-null) channels :number

The number of audio channels (ie: 1 for mono, 2 for stereo).
Type:
  • number
Source:

(non-null) rate :number

The number of samples per second, per channel.
Type:
  • number
Source:

Methods

(static) parse(mimetypenon-null) → {Guacamole.RawAudioFormat}

Parses the given mimetype, returning a new Guacamole.RawAudioFormat which describes the type of raw audio data represented by that mimetype. If the mimetype is not a supported raw audio data mimetype, null is returned.
Parameters:
Name Type Description
mimetype string The audio mimetype to parse.
Source:
Returns:
A new Guacamole.RawAudioFormat which describes the type of raw audio data represented by the given mimetype, or null if the given mimetype is not supported.
Type
Guacamole.RawAudioFormat