libtransistor
A userland library for the Nintendo Switch
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
Functions
audio.h File Reference

Audio output. More...

#include <libtransistor/types.h>
#include <libtransistor/audio.h>
Include dependency graph for audio.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

result_t audio_ipc_init ()
 Initialize Audio.
 
result_t audio_ipc_list_outputs (char(*names)[0x20], int max_names, uint32_t *num_names)
 Lists the audio outputs. More...
 
result_t audio_ipc_open_output (const char name[0x20], audio_output_t *out)
 Opens an audio output. More...
 
result_t audio_ipc_output_get_state (audio_output_t *out, audio_output_state_t *state)
 Get the current state of the audio output. More...
 
result_t audio_ipc_output_start (audio_output_t *out)
 Start audio output. More...
 
result_t audio_ipc_output_stop (audio_output_t *out)
 Stop audio output. More...
 
result_t audio_ipc_output_register_buffer_event (audio_output_t *out, handle_t *event)
 Get buffer-release event. More...
 
result_t audio_ipc_output_append_buffer (audio_output_t *out, audio_output_buffer_t *buffer)
 audio_ipc_output_append_buffer More...
 
result_t audio_ipc_output_get_released_buffer (audio_output_t *out, uint32_t *num_released, audio_output_buffer_t **buffer)
 audio_ipc_output_get_released_buffer More...
 
result_t audio_ipc_output_contains_buffer (audio_output_t *out, audio_output_buffer_t *buffer, bool *contains)
 audio_ipc_output_contains_buffer More...
 
void audio_ipc_output_close (audio_output_t *out)
 Closes the audio output. More...
 
void audio_ipc_finalize ()
 Finalize audio.
 

Detailed Description

Audio output.

Function Documentation

result_t audio_ipc_list_outputs ( char(*)  names[0x20],
int  max_names,
uint32_t *  num_names 
)

Lists the audio outputs.

Parameters
namesArray of audio output names
max_namesMaximum number of names that will fit in the array
num_namesActual number of names returned
result_t audio_ipc_open_output ( const char  name[0x20],
audio_output_t out 
)

Opens an audio output.

Parameters
nameName of the output (from audio_ipc_list_outputs)
outOutput structure to initialize
result_t audio_ipc_output_append_buffer ( audio_output_t out,
audio_output_buffer_t buffer 
)

audio_ipc_output_append_buffer

Parameters
outAudio output to append buffer to
bufferAudio buffer to append
void audio_ipc_output_close ( audio_output_t out)

Closes the audio output.

Parameters
outAudio output to query
result_t audio_ipc_output_contains_buffer ( audio_output_t out,
audio_output_buffer_t buffer,
bool *  contains 
)

audio_ipc_output_contains_buffer

Parameters
outAudio output to query
bufferBuffer to query
containsWhether or not the buffer has been appended
result_t audio_ipc_output_get_released_buffer ( audio_output_t out,
uint32_t *  num_released,
audio_output_buffer_t **  buffer 
)

audio_ipc_output_get_released_buffer

Parameters
outAudio output to query
num_releasedNumber of released buffers
bufferPointer to released buffer
result_t audio_ipc_output_get_state ( audio_output_t out,
audio_output_state_t state 
)

Get the current state of the audio output.

Parameters
outAudio output to query
stateReturned state
result_t audio_ipc_output_register_buffer_event ( audio_output_t out,
handle_t event 
)

Get buffer-release event.

Parameters
outAudio output
eventAcquired event

This event is signalled whenever an audio buffer is released.

result_t audio_ipc_output_start ( audio_output_t out)

Start audio output.

Parameters
outAudio output to start
result_t audio_ipc_output_stop ( audio_output_t out)

Stop audio output.

Parameters
outAudio output to stop