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 [OTSession [publicar:error:] mensaje.

El SDK de OpenTok para iOS admite la publicación en todos los dispositivos iOS multinúcleo. Consulta «Requisitos para desarrolladores y clientes» en el archivo README del SDK de OpenTok para iOS.

Propiedades

delegate

Tipo: id<OTPublisherKitDelegate>

El OTPublisherDelegate objeto, que es el delegado de la OTPublisher objeto.

Véase también [OTPublisherKit [audioLevelDelegate], [OTPublisherKit networkStatsDelegate] y [OTPublisherKit [rtcStatsReportDelegate].

audioLevelDelegate

Tipo: id<OTPublisherKitAudioLevelDelegate>

Recibe periódicamente informes sobre los niveles de audio de esta editorial.

Se trata de un objeto delegado distinto del establecido como propiedad «delegate» (el OTPublisherKitDelegate objeto).

Si no se configura esta propiedad, el subsistema de muestreo de audio queda desactivado.

networkStatsDelegate

Tipo: id<OTPublisherKitNetworkStatsDelegate>

El OTPublisherKitNetworkStatsDelegate objeto que recibe periódicamente estadísticas de calidad del editor.

A este objeto delegado se le envían mensajes que informan de lo siguiente:

  • Total de paquetes de audio y vídeo perdidos
  • Total de paquetes de audio y vídeo recibidos
  • Total de bytes de audio y vídeo recibidos

Se trata de un objeto delegado distinto del establecido como [OTPublisherKit propiedad [delegate] (la OTPublisherKitDelegate objeto).

Véase también [OTPublisherKit [rtcStatsReportDelegate].

rtcStatsReportDelegate

Tipo: id<OTPublisherKitRtcStatsReportDelegate>

El OTPublisherKitRtcStatsReportDelegate que recoge las estadísticas de RTC para el editor. El [OTPublisherKitRtcStatsReportDelegate El mensaje [editor:rtcStatsReport:] se envía en respuesta a la llamada a [OTPublisherKit Método [getRtcStatsReport].

session

Tipo: OTSession *

La sesión a la que pertenece este editor.

stream

Tipo: OTStream *

El OTStream objeto asociado al editor.

name

Tipo: NSString *

Una cadena que se asociará a la transmisión de este editor. Esta cadena se muestra en la parte inferior de los vídeos de los suscriptores asociados a la transmisión publicada, siempre que exista una superposición para mostrar el nombre.

El nombre debe establecerse durante la inicialización, cuando se envía el [OTPublisherKit Mensaje [initWithDelegate:settings:].

Este valor se establece por defecto en una cadena vacía.

publishAudio

Tipo: BOOL

Si se debe publicar el audio.

El valor por defecto es TRUE.

publishVideo

Tipo: BOOL

Si se debe publicar el vídeo.

El valor por defecto es TRUE.

publishCaptions

Tipo: BOOL

Si se deben activar los subtítulos.

El valor por defecto es FALSE.

captionsInputLanguage

Tipo: NSString *

El idioma de entrada preferido para los subtítulos de este editor. Utiliza uno de los códigos de idioma BCP-47 compatibles o «nil» para restablecer el valor por defecto.

Si el código de idioma no es compatible, el valor no se aplicará. Vuelve a leer esta propiedad tras configurarla para comprobar que el idioma se ha aceptado correctamente.

videoCapture

Tipo: id<OTVideoCapture>

El OTVideoCapture instancia utilizada para capturar vídeo y transmitirlo a la sesión de OpenTok.

videoType

Tipo: OTPublisherKitTipoDeVídeo

Especifica el tipo de vídeo de la transmisión publicada.

Establece este valor en uno de los siguientes:

  • OTPublisherKitVideoTypeScreen — Optimiza la codificación de vídeo para compartir pantalla. Para publicar una transmisión de pantalla compartida, es necesario implementar un capturador de vídeo personalizado para el OTPublisherKit objeto. Véase [OTPublisherKit videoCapture]. Se recomienda utilizar una frecuencia de fotogramas baja (5 fotogramas por segundo o menos) con este tipo de vídeo. Cuando se utiliza el tipo de vídeo de pantalla en una sesión que emplea el servidor multimedia OpenTok, el OTPublisherKitConfiguración Las propiedades de recambio de audio están configuradas en «NO» de forma predeterminada; esto desactiva la función de recambio solo de audio, de modo que el vídeo no se interrumpa en los suscriptores. Véase el OpenTok Media Router.
  • OTPublisherKitVideoTypeCamera — Esta es la configuración predeterminada, que debes utilizar cuando emplees una cámara como fuente de vídeo.

videoRender

Tipo: id<OTVideoRender>

El OTVideoRender instancia utilizada para procesar el vídeo que se transmite a la sesión de OpenTok.

maxVideoBitrate

Tipo: int

La tasa de bits máxima del vídeo para la transmisión del editor, en bits por segundo (bps).

Esta propiedad establece un límite máximo explícito para la tasa de bits del vídeo del editor, entre 5.000 y 10.000.000. Al establecer esta propiedad en 0 elimina cualquier límite manual y vuelve al comportamiento predeterminado de velocidad de bits adaptativa basada en preajustes, sin ningún límite explícito.

Al leer esta propiedad, devuelve la velocidad de transmisión máxima configurada actualmente en bps. Si no se ha establecido ninguna velocidad de transmisión manual, o si hay un ajuste preestablecido de velocidad de transmisión activo, el valor es 0.

Un valor de 0 indica que no se aplica ningún límite explícito de velocidad de transmisión y que la transmisión funciona según reglas preestablecidas adaptativas para optimizar la calidad.

Véase también [OTPublisherKit [videoBitratePreset] y Velocidad de bits máxima del editor.

videoBitratePreset

Tipo: Preajuste de velocidad de bits de vídeo OT

La estrategia de configuración preestablecida de la tasa de bits de vídeo aplicada a la transmisión de vídeo del editor.

Esta propiedad configura una estrategia de velocidad de bits predefinida para equilibrar la calidad del vídeo y el uso del ancho de banda. Entre los ajustes predefinidos disponibles se incluyen el comportamiento predeterminado, el ahorro moderado de ancho de banda y el ahorro agresivo de ancho de banda. Las estrategias predefinidas permiten controlar el comportamiento del codificador sin necesidad de especificar valores explícitos de velocidad de bits.

Las configuraciones predefinidas y los ajustes manuales de la tasa de bits son mutuamente excluyentes. La configuración maxVideoBitrate anulará cualquier valor preestablecido y cambiará automáticamente el valor de esta propiedad a OTVideoBitratePresetCustom.

Al leer esta propiedad se obtiene el preajuste activo en ese momento. Si se ha configurado manualmente una tasa de bits personalizada, el valor será OTVideoBitratePresetCustom.

El valor por defecto es OTVideoBitratePresetDefault.

Véase también [OTPublisherKit [maxVideoBitrate] y Velocidad de bits máxima del editor.

degradationPreference

Tipo: Preferencia de degradación de OT

La política preferida que seguirá el motor de vídeo a la hora de ajustar la frecuencia de fotogramas y la resolución en función de las limitaciones de ancho de banda y de la CPU. Consulta OTDegradationPreference para obtener una descripción de los valores posibles.

targetScalabilityMode

Tipo: NSString *

El modo de escalabilidad de destino que se estableció explícitamente mediante setTargetScalabilityMode:error:. Devuelve el último valor pasado al método setter, o null si nunca se ha llamado a dicho método. Esto refleja la intención del usuario, no el modo realmente aplicado (que puede diferir debido a un recurso alternativo dependiente del códec).

Esta es una función en fase beta.

videoTransformers

Tipo: NSArray *

Conjunto de OTVideoTransformer en el orden en que se aplicará a la secuencia.

audioTransformers

Tipo: NSArray *

Conjunto de OTAudioTransformer en el orden en que se aplicará a la secuencia.

Métodos

Nombre Descripción
getRtcStatsReport() Obtiene el informe de estadísticas de RTC correspondiente al editor.
setTargetScalabilityMode:error:(mode, error) El modo de escalabilidad previsto (SVC, codificación de vídeo escalable) para este editor.
initWithDelegate:(delegate) → {instancetype} Inicializa un objeto «publisher» y especifica el objeto «delegate».
initWithDelegate:settings:(delegate, settings) → {instancetype} Inicializa el editor con los parámetros definidos por un OTPublisherKitConfiguración objeto.
initWithDelegate:name:(delegate, __attribute) → {instancetype} Inicializa un objeto «publisher» y especifica el objeto delegado y el nombre del flujo.
initWithDelegate:name:audioTrack:videoTrack:(delegate, name, audioTrack, __attribute) → {instancetype} Inicializa el editor y especifica si se habilitarán el audio y el vídeo para esta instancia.
init() → {instancetype}

getRtcStatsReport()

Obtiene el informe de estadísticas de RTC del editor. Se trata de una operación asíncrona. Establece el [OTPublisherKit propiedad [rtcStatsReportDelegate] e implementar el [OTPublisherKitRtcStatsReportDelegate método publisher:rtcStatsReport:] antes de llamar a este método. Cuando las estadísticas estén disponibles, la implementación del [OTPublisherKitRtcStatsReportDelegate Se envía el mensaje [editor:rtcStatsReport:].

Véase también [OTPublisherKit networkStatsDelegate] y [OTSubscriberKit [getRtcStatsReport].

setTargetScalabilityMode:error:(modo, error)

El modo de escalabilidad de destino (SVC, codificación de vídeo escalable) para este editor. El modo de escalabilidad controla el número de capas espaciales (resolución) y temporales (frecuencia de fotogramas) que codifica WebRTC. El modo se aplica a la ruta multimedia del Media Router.

Se puede llamar al «setter» en cualquier momento; no es necesario que haya finalizado la negociación de la ruta de medios. El modo se aplicará una vez que se haya establecido la ruta de medios del enrutador de medios.

Si se negocia un códec que no sea SVC (VP8, H.264) en la ruta de medios del enrutador multimedia, se utiliza el modo aplicable más cercano: las capas espaciales se fijan obligatoriamente en 1, conservando la dimensión temporal (por ejemplo, L2T2 → L1T2 cuando se negocia VP8).

Parámetros:
Nombre Tipo Descripción
mode NSString * La cadena que indica el modo de escalabilidad deseado (por ejemplo, «L1T3»). Debe ser una de las siguientes opciones: L1T1, L1T2, L1T3, L2T1, L2T2, L2T3, L3T1, L3T2, L3T3.
error NSError * * En caso de fallo, establecer en un OTError con el dominio OT_PUBLISHER_ERROR_DOMAIN y el código OTPublisherInvalidScalabilityMode.

initWithDelegate:(delegate) → {instancetype}

Inicializa un objeto «publisher» y especifica el objeto «delegate».

Al ejecutarse en el simulador de iOS de Xcode, este método devuelve nil.

Parámetros:
Nombre Tipo Descripción
delegate id<OTPublisherKitDelegate> El delegado (OTPublisherKitDelegate) objeto para el editor.
Devoluciones:

El puntero a la instancia, o nil si la inicialización ha fallado.

initWithDelegate:settings:(delegate, settings) → {instancetype}

Inicializa el editor con los parámetros definidos por un OTPublisherKitConfiguración objeto.

Parámetros:
Nombre Tipo Descripción
delegate id<OTPublisherKitDelegate> El delegado (OTPublisherKitDelegate) objeto para el editor.
settings OTPublisherKitSettings * El (OTPublisherKitConfiguración) objeto que define la configuración del editor.
Devoluciones:

initWithDelegate:name:(delegate, __attribute) → {instancetype}

Inicializa un objeto «publisher» y especifica el objeto delegado y el nombre del flujo.

Este método está obsoleto. Utiliza [OTPublisherKit [initWithDelegate:settings:] en su lugar.

Al ejecutarse en el simulador de iOS de Xcode, este método devuelve nil.

Parámetros:
Nombre Tipo Descripción
delegate id<OTPublisherKitDelegate> El delegado (OTPublisherKitDelegate) objeto para el editor.
__attribute (obsoleto(("Utiliza en su lugar initWithDelegate: settings:")))
Devoluciones:

El puntero a la instancia, o nil si la inicialización ha fallado.

initWithDelegate:name:audioTrack:videoTrack:(delegate, name, audioTrack, __attribute) → {instancetype}

Inicializa el editor y especifica si se habilitarán el audio y el vídeo para esta instancia.

Este método está obsoleto. Utiliza [OTPublisherKit [initWithDelegate:settings:] en su lugar.

Si se establece «NO» en «audioTrack» o en «videoTrack», el subsistema correspondiente no se inicializará, y al establecer el [OTPublisherKit publishAudio] y [OTPublisherKit Las propiedades [publishVideo] no tendrán ningún efecto.

Si tu aplicación no requiere el uso de audio ni vídeo, se recomienda configurar estos valores en lugar de utilizar el [OTPublisherKit publishAudio] y [OTPublisherKit Las propiedades [publishVideo], que solo desactivan las pistas de forma temporal.

Parámetros:
Nombre Tipo Descripción
delegate id<OTPublisherKitDelegate> El delegado (OTPublisherKitDelegate) objeto para el editor.
name NSString * El nombre del vídeo del editor. El [OTStream La propiedad [nombre] de una transmisión publicada por este emisor se establecerá en este valor (en todos los clientes).
audioTrack BOOL Si se publica el audio (SÍ) o no (NO).
__attribute (obsoleto(("Utiliza en su lugar initWithDelegate: settings:")))
Devoluciones:

init() → {instancetype}

Devoluciones: