otc_audio_device_callbacks

Cette structure comprend un ensemble de pointeurs vers des fonctions de rappel destinées à être utilisées avec un périphérique audio. Le SDK appelle ces fonctions lorsque des événements liés au périphérique audio se produisent.

Tous les rappels ne seront pas effectués sur l'application ou le thread principal, mais sur un thread interne. L'application doit renvoyer le rappel le plus rapidement possible afin d'éviter de bloquer le thread interne.

Outre les fonctions de rappel, la structure comprend un pointeur `user_data` qui pointe vers des données que vous pouvez définir et qui sont liées au périphérique audio.

Propriétés

Nom Type Description
user_data void * Un pointeur vers les données que vous avez définies concernant le périphérique audio.
reserved void * Un pointeur nul vers une zone de mémoire contenant des ressources réservées utilisées pour la mise en œuvre interne.

Rappels

Nom Description
init(audio_device, user_data) → {otc_bool} Appelée lorsque le SDK demande au périphérique audio de s'initialiser.
destroy(audio_device, user_data) → {otc_bool} Appelée lorsque le SDK demande la destruction du périphérique audio.
init_capturer(audio_device, user_data) → {otc_bool} Appelée lorsque le SDK demande au module de capture audio d'initialiser le périphérique audio.
destroy_capturer(audio_device, user_data) → {otc_bool} Cette méthode est appelée lorsque le SDK a terminé la capture audio et qu'il est temps de détruire le capteur audio associé au périphérique audio.
start_capturer(audio_device, user_data) → {otc_bool} Appelée lorsque le SDK demande au périphérique audio de commencer à capturer des échantillons audio.
stop_capturer(audio_device, user_data) → {otc_bool} Appelée lorsque le SDK demande au module de capture audio du périphérique audio d'arrêter l'échantillonnage audio.
is_capturer_initialized(audio_device, user_data) → {otc_bool} Si le périphérique s'est initialisé pour l'échantillonnage audio.
is_capturer_started(audio_device, user_data) → {otc_bool} Si l'appareil a commencé l'échantillonnage audio.
get_estimated_capture_delay(audio_device, user_data) → {int} Appelée lorsque le SDK demande le délai de capture estimé pour le périphérique audio, en ms.
get_capture_settings(audio_device, user_data, settings) → {otc_bool} Appelée lorsque le SDK demande les paramètres de capture audio utilisés par le périphérique audio.
init_renderer(audio_device, user_data) → {otc_bool} Appelée lorsque le SDK demande au périphérique audio de s'initialiser en vue de la restitution audio.
destroy_renderer(audio_device, user_data) → {otc_bool} Cette méthode est appelée lorsque le SDK a terminé le rendu audio et qu'il est temps de détruire le moteur de rendu audio pour le périphérique audio.
start_renderer(audio_device, user_data) → {otc_bool} Appelée lorsque le SDK demande au périphérique audio de commencer la lecture du son.
stop_renderer(audio_device, user_data) → {otc_bool} Appelée lorsque le SDK demande au périphérique audio d'arrêter la lecture du son.
is_renderer_initialized(audio_device, user_data) → {otc_bool} Si le périphérique a été initialisé pour la lecture audio.
is_renderer_started(audio_device, user_data) → {otc_bool} Si l'appareil a lancé la lecture audio.
get_estimated_render_delay(audio_device, user_data) → {int} Appelée lorsque le SDK demande le délai de rendu estimé pour le périphérique audio, en ms.
get_render_settings(audio_device, user_data, settings) → {otc_bool} Appelée lorsque le SDK demande les paramètres de rendu audio utilisés par l'appareil.

init(périphérique_audio, données_utilisateur) → {otc_bool}

Appelée lorsque le SDK demande au périphérique audio de s'initialiser.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant soit une erreur, soit une réussite.

destroy(périphérique_audio, données_utilisateur) → {otc_bool}

Appelée lorsque le SDK demande la destruction du périphérique audio.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant soit une erreur, soit une réussite.

init_capturer(périphérique_audio, données_utilisateur) → {otc_bool}

Appelée lorsque le SDK demande au module de capture audio d'initialiser le périphérique audio.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant soit une erreur, soit une réussite.

destroy_capturer(périphérique_audio, données_utilisateur) → {otc_bool}

Cette méthode est appelée lorsque le SDK a terminé la capture audio et qu'il est temps de détruire le capteur audio associé au périphérique audio.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant soit une erreur, soit une réussite.

start_capturer(périphérique_audio, données_utilisateur) → {otc_bool}

Appelée lorsque le SDK demande au périphérique audio de commencer à capturer des échantillons audio.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant soit une erreur, soit une réussite.

stop_capturer(périphérique_audio, données_utilisateur) → {otc_bool}

Appelée lorsque le SDK demande au module de capture audio du périphérique audio d'arrêter l'échantillonnage audio.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant soit une erreur, soit une réussite.

is_capturer_initialized(audio_device, user_data) → {otc_bool}

Si le périphérique s'est initialisé pour l'échantillonnage audio.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant si le périphérique est initialisé ou non.

is_capturer_started(périphérique_audio, données_utilisateur) → {otc_bool}

Si l'appareil a commencé l'échantillonnage audio.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant si le processus est lancé ou non.

get_estimated_capture_delay(périphérique_audio, données_utilisateur) → {int}

Appelée lorsque le SDK demande le délai de capture estimé pour le périphérique audio, en ms.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.
Retours :

Le délai de capture estimé en ms.

get_capture_settings(périphérique_audio, données_utilisateur, paramètres) → {otc_bool}

Appelée lorsque le SDK demande les paramètres de capture audio utilisés par le périphérique audio.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.
settings struct otc_audio_device_settings * Un pointeur vers une structure contenant les paramètres.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant soit une erreur, soit une réussite.

init_renderer(périphérique_audio, données_utilisateur) → {otc_bool}

Appelée lorsque le SDK demande au périphérique audio de s'initialiser en vue de la restitution audio.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant soit une erreur, soit une réussite.

destroy_renderer(périphérique_audio, données_utilisateur) → {otc_bool}

Cette méthode est appelée lorsque le SDK a terminé le rendu audio et qu'il est temps de détruire le moteur de rendu audio pour le périphérique audio.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant soit une erreur, soit une réussite.

start_renderer(périphérique_audio, données_utilisateur) → {otc_bool}

Appelée lorsque le SDK demande au périphérique audio de commencer la lecture du son.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant soit une erreur, soit une réussite.

stop_renderer(périphérique_audio, données_utilisateur) → {otc_bool}

Appelée lorsque le SDK demande au périphérique audio d'arrêter la lecture du son.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant soit une erreur, soit une réussite.

is_renderer_initialized(audio_device, user_data) → {otc_bool}

Si le périphérique a été initialisé pour la lecture audio.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant si elle est initialisée ou non.

is_renderer_started(audio_device, user_data) → {otc_bool}

Si l'appareil a lancé la lecture audio.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant si le processus est lancé ou non.

get_estimated_render_delay(audio_device, user_data) → {int}

Appelée lorsque le SDK demande le délai de rendu estimé pour le périphérique audio, en ms.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.
Retours :

Le délai de rendu estimé en ms.

get_render_settings(périphérique_audio, données_utilisateur, paramètres) → {otc_bool}

Appelée lorsque le SDK demande les paramètres de rendu audio utilisés par l'appareil.

Paramètres :
Nom Type Description
audio_device const otc_audio_device * Un pointeur vers l'instance du périphérique audio.
user_data void * Un pointeur vers les données utilisateur (user_data) que vous avez définies pour le périphérique audio.
settings struct otc_audio_device_settings * Un pointeur vers une structure contenant les paramètres.

Voir : : - otc_bool

Retours :

Valeur booléenne indiquant soit une erreur, soit une réussite.