media_transformer.h

Este archivo incluye funciones para trabajar con transformadores multimedia personalizados y con los transformadores de la biblioteca Vonage Media Processor. Para obtener más información, consulta esta guía para desarrolladores.

Nota: Esta funcionalidad solo es aplicable al SDK para macOS de la Video API de Vonage. No funciona en el SDK para Linux de la Video API de Vonage.

Incluye: audio_data.h, video_frame.h

#define OTC_MEDIA_TRANSFORMER_ERROR_SPACE

#define OTC_MEDIA_TRANSFORMER_ERROR_SPACE 0x0A000000

typedef otc_video_transformer

Transformador de vídeo de OpenTok.

typedef struct otc_video_transformer otc_video_transformer;

typedef otc_audio_transformer

Transformador de audio de OpenTok.

typedef struct otc_audio_transformer otc_audio_transformer;

enumeración otc_media_transformer_error_code

Nombre Valor Descripción
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

enumeración otc_media_transformer_type

Tipos de transformadores de medio disponibles.

Nombre Valor Descripción
OTC_MEDIA_TRANSFORMER_TYPE_CUSTOM 0
OTC_MEDIA_TRANSFORMER_TYPE_VONAGE

Funciones

Nombre Descripción
otc_video_transformer_create(type, name, properties, cb, user_data) → {struct otc_video_transformer *} Crea una instancia de un transformador de vídeo de Vonage Media Library o de un transformador de vídeo personalizado.
otc_audio_transformer_create(type, name, properties, cb, user_data) → {struct otc_audio_transformer *} Crea una instancia de un transformador de audio personalizado.
otc_video_transformer_delete(video_transformer) → {otc_status} Nota: Esta función solo es aplicable al SDK de macOS de la Video API de Vonage.
otc_audio_transformer_delete(audio_transformer) → {otc_status} Nota: Esta función solo es aplicable al SDK de macOS de la Video API de Vonage.
otc_get_media_transformers_error_message(error) → {const char *} Obtiene el mensaje de error asociado al código de error de los transformadores multimedia proporcionado.

otc_video_transformer_create(tipo, nombre, propiedades, cb, datos_de_usuario) → {struct otc_video_transformer *}

Crea una instancia de un transformador de vídeo de Vonage Media Library o de un transformador de vídeo personalizado. Esta función es compatible con el Vonage Client SDK para macOS (pero no con el SDK para Linux). Para obtener más información, consulta Uso de la biblioteca Vonage Media Processor.

Importante: En la versión 2.27.3+ del Client SDK de Vonage Video para macOS, es necesario añadir la biblioteca multimedia de Vonage por separado del Client SDK de Vonage Video para macOS. Para obtener más información, consulta Integración con la biblioteca multimedia de Vonage. Consulta la información adicional en el archivo README.md de la biblioteca multimedia de Vonage.

Si se produce un error, se devuelve NULL y se establece «errno».

Parámetros:
Nombre Tipo Descripción
type enumeración otc_media_transformer_type El tipo de transformador. Configúralo en OTC_MEDIA_TRANSFORMER_TYPE_CUSTOM para un transformador personalizado. Establece el valor en OTC_MEDIA_TRANSFORMER_TYPE_VONAGE para un transformador de la biblioteca multimedia de Vonage.
name const char * El nombre del transformador de la biblioteca multimedia de Vonage o un nombre único para el transformador de vídeo personalizado.
properties const char * Una cadena JSON con las propiedades del transformador de vídeo de Vonage.
cb video_transform_callback La función de devolución de llamada que llevará a cabo una transformación personalizada (no se tiene en cuenta en el caso de los transformadores de Vonage)
user_data void * Datos opacos facilitados por el usuario y devueltos en la llamada de retorno.
Devoluciones:

video_transformer: puntero opaco al transformador de vídeo que se va a crear. NULL si se produce un error (lo cual se puede comprobar mediante «errno»).

otc_audio_transformer_create(tipo, nombre, propiedades, cb, datos_de_usuario) → {struct otc_audio_transformer *}

Crea una instancia de un transformador de audio personalizado.

Nota: Esta función solo es aplicable al SDK de macOS de la Video API de Vonage. No funciona en el SDK de Linux de la Video API de Vonage. Si se produce un error, se devuelve NULL y se establece «errno».

Parámetros:
Nombre Tipo Descripción
type enumeración otc_media_transformer_type El tipo de transformador. Configúralo en OTC_MEDIA_TRANSFORMER_TYPE_CUSTOM para un transformador a medida.
name const char * Un nombre para el transformador personalizado.
properties const char * Una cadena JSON con las propiedades del transformador de audio de Vonage.
cb audio_transform_callback La función de devolución de llamada que llevará a cabo una transformación personalizada (no se tiene en cuenta en el caso de los transformadores de Vonage)
user_data void * Datos opacos facilitados por el usuario y devueltos en la llamada de retorno.
Devoluciones:

audio_transformer: puntero opaco al transformador de audio que se va a crear. NULL si se produce un error (lo cual se puede comprobar mediante «errno»).

otc_video_transformer_delete(video_transformer) → {otc_status}

Nota: Esta función solo es aplicable al SDK de macOS de la Video API de Vonage. No funciona en el SDK de Linux de la Video API de Vonage.

Parámetros:
Nombre Tipo Descripción
video_transformer struct otc_video_transformer * Transformador de vídeo con puntero opaco que hay que eliminar.
Devoluciones:

otc_status

otc_audio_transformer_delete(audio_transformer) → {otc_status}

Nota: Esta función solo es aplicable al SDK de macOS de la Video API de Vonage. No funciona en el SDK de Linux de la Video API de Vonage.

Parámetros:
Nombre Tipo Descripción
audio_transformer struct otc_audio_transformer * Transformador de audio con puntero opaco que hay que eliminar.
Devoluciones:

otc_status

otc_get_media_transformers_error_message(error) → {const char *}

Obtiene el mensaje de error asociado al código de error de los transformadores multimedia proporcionado.

Parámetros:
Nombre Tipo Descripción
error int Código de error de los transformadores de soportes.
Devoluciones:

El mensaje de error correspondiente o «null» si no se encuentra ninguna descripción de error para este código.