libguac 1.5.4
Loading...
Searching...
No Matches
Typedefs
audio-fntypes.h File Reference

Function type definitions related to simple streaming audio. More...

Go to the source code of this file.

Typedefs

typedef void guac_audio_encoder_begin_handler(guac_audio_stream *audio)
 Handler which is called when the audio stream is opened.
 
typedef void guac_audio_encoder_flush_handler(guac_audio_stream *audio)
 Handler which is called when the audio stream needs to be flushed.
 
typedef void guac_audio_encoder_end_handler(guac_audio_stream *audio)
 Handler which is called when the audio stream is closed.
 
typedef void guac_audio_encoder_join_handler(guac_audio_stream *audio, guac_user *user)
 Handler which is called when a new user has joined the Guacamole connection associated with the audio stream.
 
typedef void guac_audio_encoder_write_handler(guac_audio_stream *audio, const unsigned char *pcm_data, int length)
 Handler which is called when PCM data is written to the audio stream.
 

Detailed Description

Function type definitions related to simple streaming audio.

Typedef Documentation

◆ guac_audio_encoder_begin_handler

typedef void guac_audio_encoder_begin_handler(guac_audio_stream *audio)

Handler which is called when the audio stream is opened.

Parameters
audioThe audio stream being opened.

◆ guac_audio_encoder_end_handler

typedef void guac_audio_encoder_end_handler(guac_audio_stream *audio)

Handler which is called when the audio stream is closed.

Parameters
audioThe audio stream being closed.

◆ guac_audio_encoder_flush_handler

typedef void guac_audio_encoder_flush_handler(guac_audio_stream *audio)

Handler which is called when the audio stream needs to be flushed.

Parameters
audioThe audio stream being flushed.

◆ guac_audio_encoder_join_handler

typedef void guac_audio_encoder_join_handler(guac_audio_stream *audio, guac_user *user)

Handler which is called when a new user has joined the Guacamole connection associated with the audio stream.

Parameters
audioThe audio stream associated with the Guacamole connection being joined.
userThe user that joined the connection.

◆ guac_audio_encoder_write_handler

typedef void guac_audio_encoder_write_handler(guac_audio_stream *audio, const unsigned char *pcm_data, int length)

Handler which is called when PCM data is written to the audio stream.

The format of the PCM data is dictated by the properties of the audio stream.

Parameters
audioThe audio stream to which data is being written.
pcm_dataA buffer containing the raw PCM data to be written.
lengthThe number of bytes within the buffer that should be written to the audio stream.