media_transformer.h

Ce fichier contient des fonctions permettant d'utiliser des transformateurs multimédias personnalisés et ceux de la bibliothèque Vonage Media Processor. Pour plus d'informations, consultez ce guide du développeur.

Remarque : Cette fonctionnalité ne s'applique qu'au SDK macOS de la Video API Vonage. Elle ne fonctionne pas avec le SDK Linux de la Video API Vonage.

Comprend : audio_data.h, video_frame.h

#define OTC_MEDIA_TRANSFORMER_ERROR_SPACE

#define OTC_MEDIA_TRANSFORMER_ERROR_SPACE 0x0A000000

typedef otc_video_transformer

Transformateur vidéo OpenTok.

typedef struct otc_video_transformer otc_video_transformer;

typedef otc_audio_transformer

Transformateur audio OpenTok.

typedef struct otc_audio_transformer otc_audio_transformer;

énumération otc_media_transformer_error_code

Nom Valeur Description
OTC_MEDIA_TRANSFORMER_INTERNAL_ERROR 0x0A000000
OTC_MEDIA_TRANSFORMER_INVALID_TYPE
OTC_MEDIA_TRANSFORMER_NAME_NOT_PROVIDED
OTC_MEDIA_TRANSFORMER_CUSTOM_CALLBACK_NOT_PROVIDED
OTC_MEDIA_TRANSFORMER_PROPERTIES_NOT_PROVIDED
OTC_MEDIA_TRANSFORMER_MODEL_NOT_FOUND
OTC_MEDIA_TRANSFORMER_OPENTOK_TRANSFORMERS_LIBRARY_NOT_LOADED
OTC_MEDIA_TRANSFORMER_OPENTOK_TRANSFORMERS_SYMBOL_NOT_FOUND

énumération otc_media_transformer_type

Types de transformateurs de média disponibles.

Nom Valeur Description
OTC_MEDIA_TRANSFORMER_TYPE_CUSTOM 0
OTC_MEDIA_TRANSFORMER_TYPE_VONAGE

Fonctions

Nom Description
otc_video_transformer_create(type, name, properties, cb, user_data) → {struct otc_video_transformer *} Crée une instance d'un transformateur vidéo de la bibliothèque multimédia Vonage ou d'un transformateur vidéo personnalisé.
otc_audio_transformer_create(type, name, properties, cb, user_data) → {struct otc_audio_transformer *} Crée une instance d'un transformateur audio personnalisé.
otc_video_transformer_delete(video_transformer) → {otc_status} Remarque : Cette fonction s'applique uniquement au SDK macOS de la Video API Vonage.
otc_audio_transformer_delete(audio_transformer) → {otc_status} Remarque : Cette fonction s'applique uniquement au SDK macOS de la Video API Vonage.
otc_get_media_transformers_error_message(error) → {const char *} Récupère le message d'erreur associé au code d'erreur du transformateur multimédia indiqué.

otc_video_transformer_create(type, nom, propriétés, cb, données_utilisateur) → {struct otc_video_transformer *}

Crée une instance d'un transformateur vidéo de la bibliothèque multimédia Vonage ou d'un transformateur vidéo personnalisé. Cette fonction est prise en charge dans le Client SDK Vonage Video pour macOS (mais pas dans le SDK Linux). Pour plus d'informations, consultez Utilisation de la bibliothèque Vonage Media Processor.

Important : Dans la version 2.27.3+ du Vonage Client SDK pour macOS, vous devez ajouter la bibliothèque multimédia Vonage séparément du Vonage Video Client SDK pour macOS. Pour plus d'informations, consultez Intégration de la médiathèque de Vonage. Consultez les informations complémentaires dans le fichier README.md de la médiathèque Vonage.

En cas d'erreur, la valeur NULL est renvoyée et « errno » est mis à jour.

Paramètres :
Nom Type Description
type énumération otc_media_transformer_type Le type de transformateur. Réglez-le sur OTC_MEDIA_TRANSFORMER_TYPE_CUSTOM pour un transformateur personnalisé. Définissez la valeur sur OTC_MEDIA_TRANSFORMER_TYPE_VONAGE pour un transformateur de la médiathèque Vonage.
name const char * Le nom du transformateur « Vonage Media Library » ou un nom unique pour le transformateur vidéo personnalisé.
properties const char * Une chaîne JSON contenant les propriétés du transformateur vidéo Vonage.
cb video_transform_callback La fonction de rappel qui effectuera une transformation personnalisée (ignorée pour les transformateurs Vonage)
user_data void * Données opaques transmises par l'utilisateur et renvoyées dans la fonction de rappel.
Retours :

video_transformer : pointeur opaque vers le transformateur vidéo à créer. NULL en cas d'erreur (ce qui peut être vérifié via « errno »).

otc_audio_transformer_create(type, nom, propriétés, cb, données_utilisateur) → {struct otc_audio_transformer *}

Crée une instance d'un transformateur audio personnalisé.

Remarque : Cette fonction s'applique uniquement au SDK macOS de la Video API. Elle ne fonctionne pas dans le SDK Linux de la Video API. En cas d'erreur, la valeur NULL est renvoyée et « errno » est défini.

Paramètres :
Nom Type Description
type énumération otc_media_transformer_type Le type de transformateur. Réglez-le sur OTC_MEDIA_TRANSFORMER_TYPE_CUSTOM pour un transformateur sur mesure.
name const char * Un nom pour le transformateur personnalisé.
properties const char * Une chaîne JSON contenant les propriétés du transformateur audio Vonage.
cb audio_transform_callback La fonction de rappel qui effectuera une transformation personnalisée (ignorée pour les transformateurs Vonage)
user_data void * Données opaques transmises par l'utilisateur et renvoyées dans la fonction de rappel.
Retours :

audio_transformer : pointeur opaque vers le transformateur audio à créer. NULL en cas d'erreur (ce qui peut être vérifié via « errno »).

otc_video_transformer_delete(video_transformer) → {otc_status}

Remarque : Cette fonction ne s'applique qu'au SDK macOS de la Video API Vonage. Elle ne fonctionne pas dans le SDK Linux de la Video API Vonage.

Paramètres :
Nom Type Description
video_transformer struct otc_video_transformer * Transformateur vidéo à pointeur opaque à supprimer.
Retours :

otc_status

otc_audio_transformer_delete(audio_transformer) → {otc_status}

Remarque : Cette fonction ne s'applique qu'au SDK macOS de la Video API Vonage. Elle ne fonctionne pas dans le SDK Linux de la Video API Vonage.

Paramètres :
Nom Type Description
audio_transformer struct otc_audio_transformer * Transformateur audio à pointeur opaque à supprimer.
Retours :

otc_status

otc_get_media_transformers_error_message(error) → {const char *}

Récupère le message d'erreur associé au code d'erreur du transformateur multimédia indiqué.

Paramètres :
Nom Type Description
error int Code d'erreur des transformateurs de support.
Retours :

Le message d'erreur associé ou la valeur « null » si aucune description d'erreur n'est trouvée pour ce code.