Referencia del SDK de OpenTok para iOS
El SDK de OpenTok para iOS incluye las siguientes clases:
| Clase | Descripción |
|---|---|
| OTAudioBus | El bus de audio gestiona los datos de audio entre la red y el dispositivo de audio. Llama al método [OTAudioDevice setAudioBus:] para definir el objeto que implementa el protocolo OTAudioBus. El dispositivo de audio envía las muestras de audio capturadas al bus de audio y recupera de él las muestras de audio aún no procesadas. El objeto |
| OTAudioData | Define los datos de audio que se pasan al método [OTCustomAudioTransformer transform:]. |
| OTAudioDevice | Define un dispositivo de audio para su uso en una sesión. Véase [OTAudioDeviceManager setAudioDevice:]. |
| OTAudioDeviceManager | Utiliza AudioDeviceManager para configurar un dispositivo de audio personalizado que vaya a utilizar la aplicación. El dispositivo de audio gestiona el acceso al hardware de captura y reproducción de audio. Solo puedes definir una única fuente de captura de audio y un único destino de reproducción para todo el proceso. No es posible configurarlos individualmente para cada publ |
| OTAudioFormat | Define el formato del audio cuando se utiliza un controlador de audio personalizado. Ten en cuenta que, en los dispositivos iOS, debes especificar una frecuencia de muestreo de 32, 16 u 8 kHz (32000, 16000 u 8000); no utilices una frecuencia de muestreo de 44,1 kHz en dispositivos iOS. Sin embargo, en el simulador, la frecuencia de muestreo debe ser de 44,1 kHz (44100) para que funcione correctamente. |
| OTAudioSessionManager | Define un gestor de sesiones de audio para su uso con servicios de llamadas como CallKit. La implementación de este protocolo es opcional. Los dispositivos de audio personalizados pueden implementar estos métodos para gestionar la AVAudioSession. El dispositivo de audio predeterminado del SDK proporciona una implementación operativa. Para obtener más información, consulta el |
| OTAudioTransformer | Define un transformador de un flujo de audio. |
| OTCameraCaptureFrameRate | Define los valores del parámetro `cameraFrameRate` del método [OTPublisher initWithDelegate:name:cameraResolution:cameraFrameRate:]. Ten en cuenta que, en las sesiones que utilizan el OpenTok Media Router (sesiones con el modo multimedia configurado en «routed»), al reducir la frecuencia de fotogramas se reduce proporcionalmente el ancho de banda que |
| OTCameraCaptureResolution | Define los valores del parámetro «cameraResolution» del método [OTPublisher initWithDelegate:name:cameraResolution:cameraFrameRate:]. |
| OTConnection | Representa una conexión a una sesión de OpenTok. La clase `OTSession` incluye una propiedad `connection`, que es un objeto `OTConnection`. Asimismo, la clase `OTStream` incluye una propiedad `connection`, que es un objeto `OTConnection`. |
| OTCustomAudioTransformer | Define un transformador personalizado para un flujo de audio, que se pasará al método [OTAudioTransformer initWithName:transformer:]. |
| OTCustomVideoTransformer | Define un transformador personalizado para un flujo de vídeo, que se pasará al método [OTVideoTransformer initWithName:transformer:]. |
| Preferencia de degradación de OT | Para más información, consulta «Preferencias de degradación». |
| OTError | Define los errores del SDK de OpenTok para iOS. Consulta la documentación sobre las siguientes enumeraciones de constantes, que definen los valores de código de los objetos OTError: OTPublisherErrorCode, OTSessionErrorCode y OTSubscriberErrorCode. |
| OTMuteForcedInfo | Define el parámetro «muteForced» del mensaje [OTSessionDelegate session:muteForced:]. |
| Estado de la red de operaciones | Puntuación estimada del estado de la red para un transporte. Esta enumeración representa el estado general de la conexión de red para un transporte determinado (local o remoto). Normalmente se calcula a partir de métricas como la pérdida de paquetes y el ancho de banda disponible estimado. Los valores más altos indican mejores condiciones de red. |
| Fuente de degradación de la red de telecomunicaciones | Indica el origen de la degradación del vídeo o de la red en la sesión. Esta enumeración identifica qué lado de la llamada es responsable de los problemas de red observados que afectan a la calidad del vídeo. Complementa las métricas de estado de la red por tipo de transporte. |
| Motivo de la red de operaciones | Describe la causa principal que afecta al estado de la red. Estos valores indican el factor principal que influye en la evaluación actual del estado de la red, como las limitaciones de ancho de banda o la pérdida de paquetes. |
| OTPixelFormat | Define los valores del formato de píxeles para la propiedad `pixelFormat` de un objeto `OTVideoFrame`. |
| OTPublisher | Un editor captura un flujo de audio y vídeo desde el micrófono y la cámara del dispositivo. A continuación, puedes publicar el flujo de audio y vídeo en una sesión de OpenTok enviando el mensaje [OTSession publish:error:]. El SDK de OpenTok para iOS admite la publicación en todos los dispositivos iOS multinúcleo. Consulta «Desarrollador y cliente re |
| OTPublisherDelegate | Se utiliza para enviar mensajes a una instancia de OTPublisher. |
| OTPublisherErrorCode | Enumeraciones de los valores de los códigos de error utilizados por [OTPublisherKitDelegate publisher:didFailWithError:]. |
| OTPublisherKit | Un editor captura un flujo de audio y vídeo a partir de las fuentes que especifiques. A continuación, puedes publicar el flujo de audio y vídeo en una sesión de OpenTok enviando el mensaje [OTSession publish:error:]. El SDK de OpenTok para iOS admite la publicación en todos los dispositivos iOS multinúcleo. Consulta «Requisitos para desarrolladores y clientes». |
| OTPublisherKitAudioLevelDelegate | Se utiliza para supervisar los niveles de audio del editor. |
| OTPublisherKitEstadísticas de la red de audio | Describe las estadísticas de audio de un editor. Véase [OTPublisherKit setNetworkStatsDelegate:]. |
| OTPublisherKitDelegate | Se utiliza para enviar mensajes a una instancia de OTPublisher. La clase OTPublisher incluye una propiedad de delegado. Al enviar el mensaje [OTPublisherKit initWithDelegate:] o el mensaje [OTPublisherKit initWithDelegate:settings:], se especifica un objeto OTPublisherKitDelegate. |
| OTPublisherKitMediaLinkStats | Proporciona estadísticas sobre los enlaces multimedia del editor, incluidas las métricas de transporte local. Dado que el vídeo y el audio comparten el mismo transporte subyacente, esta clase agrupa las estadísticas de transporte local en un único objeto. |
| OTPublisherKitNetworkStatsDelegate | Se utiliza para supervisar las estadísticas de audio y vídeo del editor. Véase [OTPublisherKit networkStatsDelegate]. |
| OTPublisherKitRtcStatsReportDelegate | Se utiliza para enviar mensajes que informan de las estadísticas RTC del editor. Establece la propiedad [OTPublisherKit rtcStatsReportDelegate] para utilizar este delegado. Tras llamar al método [OTPublisherKit getRtcStatsReport], se envía el mensaje [OTPublisherKitRtcStatsReportDelegate publisher:rtcStatsReport:] para informar de las |
| OTPublisherKitConfiguración | Define los ajustes que se utilizarán al inicializar un editor mediante el método [OTPublisherKit initWithDelegate:settings:]. |
| OTPublisherKitVideoLayerStats | Describe las estadísticas de una única capa de vídeo publicada. En una configuración de emisión simultánea, cada entrada corresponde a una codificación de vídeo independiente (por ejemplo, flujos de baja, media y alta resolución enviados en paralelo). En el caso de la SVC (codificación de vídeo escalable), el editor suele enviar un único vídeo en |
| OTPublisherKitEstadísticas de la red de vídeo | Describe las estadísticas de vídeo de un editor. Véase [OTPublisherKit setNetworkStatsDelegate:]. |
| OTPublisherKitTipoDeVídeo | Define los valores de la propiedad [OTPublisherKit videoType]. |
| OTPublisherRtcStats | Representa las estadísticas RTC de una transmisión multimedia publicada por el editor. Véase [OTPublisherKit getRtcStatsReport]. |
| OTPublisherSettings | Define los parámetros que se utilizarán al inicializar un editor mediante el método [OTPublisher initWithDelegate:settings:]. Esto incluye los parámetros relativos a la resolución y la frecuencia de fotogramas del vídeo del editor, además de los parámetros heredados de la clase OTPublisherKitSettings. Para las sesiones que utilizan t |
| OTEditorVídeoEventoMotivo | Los eventos en los que se ha activado o desactivado el vídeo van acompañados de un código de motivo, que permite determinar por qué se activó o desactivó la pista de vídeo. |
| Restricción de calidad de OT | Describe los motivos de la restricción de calidad del emisor. Estos valores indican los ajustes de calidad del servidor multimedia (cambios espaciales/temporales) detectados durante una sesión. |
| OTSenderStats | Muestra las estadísticas de vídeo facilitadas por el remitente, como las estimaciones de la tasa de bits. |
| OTSession | El primer paso para utilizar el SDK de OpenTok para iOS es inicializar un objeto OTSession con tu clave API y un ID de sesión válido. Utiliza el objeto OTSession para conectarte a OpenTok mediante tu clave API de desarrollador y un token válido. |
| OTSessionCapabilities | Define la propiedad [OTSession capabilities]. Una vez que te hayas conectado a una sesión y se haya llamado al método [OTSessionDelegate sessionDidConnect:], esta propiedad indica si el cliente puede publicar y suscribirse a flujos en la sesión, en función del rol asignado al token utilizado para |
| OTSessionConnectionStatus | Los códigos de estado de conexión, disponibles a través de [OTSession sessionConnectionStatus]. |
| OTSessionDelegate | Se utiliza para enviar mensajes a una instancia de OTSession. La clase OTSession incluye una propiedad de delegado. Al enviar el mensaje [OTSession initWithApiKey:sessionId:delegate:], se especifica un objeto OTSessionDelegate. |
| OTSessionErrorCode | Enumeraciones de los valores de los códigos de error utilizados por [OTSessionDelegate session:didFailWithError:]. |
| OTSessionICEConfig | Define la propiedad OTSessionSettings.iceConfig. Esta propiedad define los servidores TURN que utilizará el cliente durante la sesión. Para obtener más información, consulta la guía para desarrolladores sobre servidores TURN configurables. |
| OTSessionICEIncludeServers | Define los ajustes para determinar si se deben utilizar únicamente tus servidores TURN personalizados o si se deben utilizar esos servidores además de los servidores TURN de OpenTok. Define los valores de la propiedad OTSessionSettings.iceConfig. |
| OTSessionICETransportPolicy | Define los parámetros para determinar si se deben utilizar todos los tipos de transporte ICE (como host, srflx y TURN) para establecer la conectividad multimedia o si solo se debe utilizar TURN. Se utiliza en el parámetro [OTSessionICEConfig transportPolicy]. |
| OTSessionSettings | Define los ajustes que se utilizarán al inicializar un objeto OTSession mediante el método [OTSession initWithApiKey:sessionId:delegate:settings:]. |
| OTStream | Un objeto OTStream representa un flujo multimedia, que puede contener datos de vídeo y/o audio. Utiliza instancias de OTStream para inicializar interfaces de OTSubscriber. No intentes inicializar un OTStream directamente. |
| OTStreamVideoType | Define los valores de la propiedad [OTStream videoType]. |
| OTSuscriptor | Muestra las transmisiones de OpenTok y proporciona un UIView que reproduce el vídeo y ofrece algunos controles sencillos para el usuario final. |
| OTSubscriberDelegate | OTSubscriberDelegate hereda de OTSubscriberKitDelegate e incorpora llamadas de retorno opcionales adicionales específicas de la implementación de OTSubscriber. Actualmente, solo hay una llamada de retorno adicional, pero es posible que se añadan otras en una versión futura. |
| OTSubscriberErrorCode | Enumeraciones de los valores de los códigos de error utilizados por [OTSubscriberKitDelegate subscriber:didFailWithError:]. |
| OTSubscriberKit | Un objeto OTSubscriberKit (suscriptor) se encarga de la representación de los datos multimedia vinculados a un OTStream. La clase OTSubscriberKit te permite configurar un renderizador de vídeo personalizado para la secuencia de vídeo. Utiliza esta clase si te interesa proporcionar tu propia implementación de procesamiento y representación de vídeo. De lo contrario, utiliza el OTSubscrib |
| OTSubscriberKitAudioLevelDelegate | Se utiliza para supervisar los niveles de audio del abonado. |
| OTSubscriberKitAudioNetworkStats | Describe las estadísticas de audio de un suscriptor. Véase [OTSubscriberKit setNetworkStatsDelegate:]. |
| OTSubscriberKitCaptionsDelegate | Se utiliza para recibir subtítulos de la transmisión de un suscriptor. |
| OTSubscriberKitDelegate | Se utiliza para enviar mensajes a una instancia de OTSubscriber. Al enviar el mensaje [OTSubscriberKit initWithStream:delegate:], se especifica un objeto OTSubscriberKitDelegate. |
| OTSubscriberKitMediaLinkStats | Proporciona estadísticas sobre los enlaces multimedia de los suscriptores, incluidas métricas de transporte local y remoto, así como información sobre la degradación de la red. Dado que el audio y el vídeo comparten el mismo transporte subyacente, esta clase agrupa el transporte local, el transporte del editor remoto y la fuente de degradación de la red en un único |
| OTSubscriberKitNetworkStatsDelegate | Se utiliza para supervisar las estadísticas de audio y vídeo del suscriptor. Véase [OTSubscriberKit networkStatsDelegate]. |
| OTSubscriberKitRtcStatsReportDelegate | Se utiliza para enviar mensajes con las estadísticas de RTC de los suscriptores. Establece la propiedad [OTSubscriberKit rtcStatsReportDelegate] para utilizar este delegado. Tras llamar al método [OTSubscriberKit getRtcStatsReport], se envía el mensaje [OTSubscriberKitRtcStatsReportDelegate subscriber:rtcStatsReport:] a repo. |
| OTSubscriberKitVideoNetworkStats | Describe las estadísticas de vídeo de un suscriptor. Véase [OTSubscriberKit setNetworkStatsDelegate:]. |
| OTSubscriberVideoEventReason | Los eventos en los que se ha activado o desactivado el vídeo van acompañados de un código de motivo, que permite determinar por qué se activó o desactivó la pista de vídeo. |
| OTTransportStats | Proporciona estadísticas de transporte a nivel de red. La clase OTTransportStats ofrece métricas relacionadas con la capa de transporte de red subyacente de una conexión WebRTC. Estas estadísticas reflejan condiciones actuales, como el ancho de banda disponible estimado, y pueden utilizarse para supervisar o depurar el rendimiento de la red. |
| Preajuste de velocidad de bits de vídeo OT | Estrategias predefinidas para controlar la tasa de bits de vídeo en la transmisión de un editor. Estas configuraciones predefinidas permiten aplicar estrategias de ancho de banda predefinidas sin necesidad de especificar manualmente las tasas de bits. Las configuraciones predefinidas son mutuamente excluyentes con la configuración manual de la tasa de bits. Véase [OTPublisherKit videoBitratePreset] y Publisher Max Bitr |
| OTVideoCapture | Define un capturador de vídeo que utilizará un objeto OTPublisherKit. Consulta la propiedad videoCapture de un objeto OTPublisherKit. |
| OTVideoCaptureConsumer | Define un objeto que utiliza un objeto OTVideoCapture. |
| OTVideoCodecPreference | Esta clase te permite especificar si el SDK debe seleccionar automáticamente el mejor códec de vídeo o si deseas proporcionar explícitamente una lista de códecs preferidos. Se utiliza al configurar los editores para controlar qué códecs tienen prioridad durante la negociación. Si no se utiliza, el códec especificado |
| OTVideoCodecType | Define los valores de la propiedad [OTVideoCodecPreference codecs], así como los elementos del array que utiliza el método [OTVideoCodecPreference manualWithCodecs:]. |
| OTVideoContentHint | Define los valores para el método `setVideoContentHint:` de `OTVideoCapture`. Puedes obtener más información sobre estas opciones en el borrador de trabajo del W3C. Y aquí tienes algunos ejemplos en directo. |
| OTVideoFormat | Define el formato de vídeo asignado a una instancia de un objeto OTVideoFrame. |
| OTVideoFrame | Define un fotograma de un vídeo. Véase [OTVideoRender renderVideoFrame:] y [OTVideoCaptureConsumer consumeFrame:]. |
| OTVideoOrientación | Define los valores de orientación del vídeo (arriba, abajo, izquierda, derecha) para la propiedad «orientation» de un objeto OTVideoFrame. |
| OTVideoRender | Define un renderizador de vídeo que utilizarán los objetos OTPublisherKit u OTSubscriberKit. Consulta las propiedades «videoRender» de los objetos OTPublisherKit y OTSubscriberKit. |
| OTVideoTransformer | Define un transformador de un flujo de vídeo. |
| OTVideoViewScaleBehavior | Define los valores de las propiedades [OTSubscriber viewScaleBehavior] y [OTPublisher viewScaleBehavior]. |