Referencia del SDK de OpenTok para Windows
El SDK de OpenTok para Windows incluye las siguientes clases:
| Clase | Descripción |
|---|---|
| OpenTok | Enumeraciones y delegados a nivel de espacio de nombres del espacio de nombres de OpenTok. |
| OpenTok.AudioData | Define varios parámetros relacionados con un lote de muestras de audio. |
| OpenTok.AudioDevice | Una clase que incluye métodos para configurar el dispositivo de audio que utilizarán los emisores y los receptores. |
| OpenTok.AudioDevice.AudioBus | Un bus de audio utilizado por todos los editores y suscriptores. Esta clase se utiliza tanto para leer como para escribir muestras de audio, con el fin de que estas se reproduzcan o se envíen a nodos remotos. |
| OpenTok.AudioDevice.InputAudioDevice | Representa un dispositivo de audio de entrada (como un micrófono) disponible en el sistema Windows. Véanse EnumerateInputAudioDevices y SetInputAudioDevice. |
| OpenTok.AudioDevice.Notificaciones | Representa una suscripción a las notificaciones de los dispositivos de audio del sistema. Este objeto envía eventos cuando se añade o se elimina un dispositivo de audio de entrada o salida del sistema, y cuando cambia el dispositivo de audio de entrada o salida predeterminado del sistema. Esta instancia puede eliminarse cuando ya no se utilice, para liberar los recursos no gestionados. |
| OpenTok.AudioDevice.Notifications.InputAudioDeviceEventArgs | Contiene los argumentos para los eventos del dispositivo de entrada de audio. |
| OpenTok.AudioDevice.Notifications.OutputAudioDeviceEventArgs | Contiene los argumentos para los eventos del dispositivo de salida de audio. |
| OpenTok.AudioDevice.OutputAudioDevice | Representa un dispositivo de salida de audio (como auriculares o altavoces) disponible en el sistema Windows. Véanse EnumerateOutputAudioDevices y SetOutputAudioDevice. |
| OpenTok.Configuración del dispositivo de audio | Define los parámetros obtenidos mediante los métodos IAudioDevice.GetAudioCapturerSettings() e IAudioDevice.GetAudioRendererSettings(). |
| OpenTok.AudioTransformer | Define una transformación de audio que se utilizará en la matriz Publisher.AudioTransformers. |
| OpenTok.Funcionalidades | Consulta la descripción general sobre la creación de tokens. |
| OpenTok.Conexión | La propiedad Session.Connection se establece en un objeto Connection que representa la conexión del usuario local. La propiedad Stream.Connection se establece en un objeto Connection que representa la conexión del editor de la transmisión. Para inicializar una sesión, crea un objeto Session.Builder y llama al método Build(), |
| OpenTok.Context | Se utiliza para gestionar los recursos de los objetos «Session», «Publisher» y «Subscriber». |
| OpenTok.DedicatedWorkerDispatcher | Implementación de IDispatcher que utiliza un hilo de trabajo específico para enviar eventos. Disponible para todos los marcos de presentación (WinForms, WPF, etc.). Se garantiza el orden de envío. Cada instancia de este IDispatcher utiliza un hilo diferente, por lo que, si es necesario utilizar la misma cola, se debe crear una única instancia. |
| OpenTok.DirectDispatcher | Implementación de IDispatcher que no programa eventos en absoluto. Utiliza el mismo hilo que la capa inferior para entregar los eventos. Disponible para todos los marcos de presentación (WinForms, WPF, etc.). Se garantiza el orden de entrega. Dado que se trata de un IDispatcher «No-Op», no importa si el mismo D |
| OpenTok.IAudioDevice | Define un dispositivo de audio que deben utilizar todos los emisores y suscriptores. |
| OpenTok.IceConfig | Se utiliza para la función TURN configurable. Pásalo a la propiedad IceConfig de Session.Builder. |
| OpenTok.IceServer | Un objeto IceServer representa un servidor TURN personalizado que utilizará el cliente. |
| OpenTok.ICustomAudioTransformer | Interfaz utilizada para definir un transformador de audio personalizado que se utilizará en el constructor de `AudioTransformer(string name, ICustomAudioTransformer transformer)`. |
| OpenTok.ICustomVideoTransformer | Interfaz utilizada para definir un transformador de vídeo personalizado que se utilizará en el constructor VideoTransformer.VideoTransformer(string name, ICustomVideoTransformer transformer). |
| OpenTok.IDispatcher | Interfaz de una clase que utilizan las instancias de Session, Publisher y Subscriber para programar eventos en un hilo diferente. |
| OpenTok.IVideoCapturer | La interfaz de OpenTok.IVideoCapturer. |
| OpenTok.IVideoFrameConsumer | |
| OpenTok.IVideoRenderer | |
| OpenTok.Logger | Clase auxiliar que permite configurar el nivel de registro utilizado por el SDK, ofreciendo opcionalmente una función de devolución de llamada personalizada para la gestión de registros. Esta clase ofrece una forma más segura de gestionar el registro nativo que invocar directamente la API nativa de C mediante DllImport. ADVERTENCIA: ASEGÚRATE de llamar a Disable() antes de cerrar la aplicación para evitar que se cierre |
| OpenTok.MMAudioDevice | Para utilizar este dispositivo de audio personalizado: Crea una instancia de esta clase. Utiliza AudioDevice.SetCustomAudioDevice antes de crear la primera sesión para indicar a WebRTC que se utilizará esta clase como dispositivo de audio. Utiliza los siguientes métodos de MMAudioDevice en lugar de los equivalentes estáticos de AudioDevice: E |
| OpenTok.OpenTokException | Consulta las propiedades «ErrorCode» y «Message» para obtener más detalles sobre el error. |
| OpenTok.Códecs de vídeo preferidos | Esta clase te permite especificar un orden de prioridad explícito para los códecs o optar por la selección automática de códecs. Utilízala para controlar qué códecs tienen prioridad durante la negociación, o deja que el SDK decida basándose en heurísticas internas. Para utilizar el orden manual: newPreferredVideoCodecs(newList{Codec.H264,Codec.VP8}) |
| OpenTok.Publisher | Utiliza la clase `Publisher.Builder` para crear una instancia de `Publisher`. A continuación, puedes publicar el flujo de audio y vídeo en una sesión de OpenTok llamando al método `Session.Publish(Publisher)`. La clase `Publisher` implementa la interfaz `System.IDisposable`. Asegúrate de llamar al método `Dispose()` de `Publisher` o |
| OpenTok.Publisher.AudioLevelArgs | Define los argumentos de los eventos de AudioLevel. |
| OpenTok.Publisher.AudioNetworkStats | Define un objeto de estadísticas de audio para la propiedad Stats de un objeto AudioNetworkStatsEventArgs. |
| OpenTok.Publisher.AudioNetworkStatsEventArgs | Define los argumentos para los eventos «AudioStatsUpdated». |
| OpenTok.Publisher.Builder | Crea una instancia de Builder llamando al constructor Builder(). A continuación (si se desea), configura las propiedades del objeto Builder. Después, llama al método Build() para crear un objeto Publisher. |
| OpenTok.Publisher.ErrorEventArgs | Define los argumentos del evento «Error». |
| OpenTok.Publisher.NetworkConditionChangedEventArgs | Define los argumentos de los eventos «NetworkConditionChanged» generados por el editor. |
| OpenTok.Publisher.PublisherMediaLinkStats | Proporciona estadísticas sobre los enlaces multimedia de los editores, incluidas las métricas de tráfico local. |
| OpenTok.Publisher.PublisherMediaLinkStatsEventArgs | Define los argumentos para los eventos «MediaLinkStatsUpdated». |
| OpenTok.Publisher.PublisherRtcStats | Publisher.GetRtcStatsReport |
| OpenTok.Publisher.RtcStatsReportArgs | Define los argumentos de los eventos RtcStatsReport. |
| OpenTok.Publisher.StreamEventArgs | Define los argumentos de los eventos StreamCreated y StreamDestroyed. |
| OpenTok.Publisher.VideoEventArgs | Define los argumentos para los eventos «VideoEnabled» y «VideoDisabled». |
| OpenTok.Publisher.VideoLayerStats | 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 emisor suele enviar una única codificación de vídeo, con escalabilidad (temporal, espacial o ambas) int |
| OpenTok.Publisher.VideoNetworkStats | Define un objeto de estadísticas de vídeo para la propiedad Stats de un objeto VideoNetworkStatsEventArgs. |
| OpenTok.Publisher.VideoNetworkStatsEventArgs | Define los argumentos para los eventos «VideoStatsUpdated». |
| OpenTok.Publisher.VideoQualityChangedEventArgs | Define los argumentos para los eventos «VideoQualityChanged». |
| OpenTok.Session | El primer paso para utilizar el SDK de OpenTok para Windows consiste en crear una instancia del objeto `Session` mediante la clase `Session.Builder`. La clase `Session` implementa la interfaz `System.IDisposable`. Asegúrate de llamar al método `Dispose()` del objeto `Session` para liberar sus recursos cuando ya no necesites el objeto (f |
| OpenTok.Session.ArchiveStartedEventArgs | Define los argumentos del evento ArchiveStarted. |
| OpenTok.Session.ArchiveStoppedEventArgs | Define los argumentos del evento «ArchiveStopped». |
| OpenTok.Session.Builder | Crea una instancia de Builder llamando al constructor Builder(). A continuación (si lo deseas), configura las propiedades del objeto Builder. Por último, llama al método Build() para crear un objeto Session. |
| OpenTok.Session.ConnectionEventArgs | Define los argumentos para los eventos «ConnectionCreated» y «ConnectionDropped». |
| OpenTok.Session.ErrorEventArgs | Define los argumentos del evento «Error». |
| OpenTok.Session.MuteForcedEventArgs | Define los argumentos del evento «MuteForced». |
| OpenTok.Session.SignalEventArgs | Define los argumentos del evento Session.Signal. |
| OpenTok.Session.StreamEventArgs | Define los argumentos de los eventos «StreamReceived» y «StreamDropped». |
| OpenTok.Stream | El objeto «Session» envía el evento «Session.StreamReceived» cuando hay un nuevo flujo en la sesión. Este objeto solo representa el flujo en el momento de la llamada de retorno. La sesión envía un evento «Session.StreamDropped» cuando un flujo se elimina de la sesión (por ejemplo, cuando se retira de la publicación). |
| OpenTok.Suscriptor | Utiliza la clase `Subscriber.Builder` para crear una instancia de `Subscriber`. Los suscriptores pueden conectarse para recibir contenido multimedia al llamar al método `Session.Subscribe(Subscriber)`. La clase `Subscriber` implementa la interfaz `System.IDisposable`. Asegúrate de llamar al método `Dispose()` del objeto `Subscriber` para liberar |
| OpenTok.Subscriber.AudioDataEventArgs | Define los parámetros de los eventos de OpenTok.AudioData. |
| OpenTok.Subscriber.AudioLevelArgs | Define los argumentos de los eventos de AudioLevel. |
| OpenTok.Subscriber.AudioNetworkStatsEventArgs | Define los argumentos para los eventos «AudioStatsUpdated». |
| OpenTok.Subscriber.Builder | Crea una instancia de Builder llamando al constructor Builder(). A continuación (si se desea), configura las propiedades del objeto Builder. Después, llama al método Build() para crear un objeto Subscriber. |
| OpenTok.Subscriber.CaptionTextArgs | Define los argumentos para los eventos CaptionText. |
| OpenTok.Subscriber.ErrorEventArgs | Define los argumentos del evento «Error». |
| OpenTok.Subscriber.NetworkConditionChangedEventArgs | Define los argumentos para los eventos «NetworkConditionChanged» generados por el suscriptor. |
| OpenTok.Subscriber.RtcStatsReportArgs | Define los argumentos de los eventos RtcStatsReport. |
| OpenTok.Subscriber.SenderStats | Esta propiedad está obsoleta. Utiliza en su lugar SubscriberMediaLinkStats, que proporciona métricas de red completas, incluida información sobre el rendimiento del transporte del editor remoto y la atribución de la degradación de la red. |
| OpenTok.Subscriber.SubscriberMediaLinkStats | Proporciona estadísticas sobre los enlaces de los abonados, incluidas métricas de transporte locales y remotas, así como información sobre la degradación de la red. |
| OpenTok.Subscriber.SubscriberMediaLinkStatsEventArgs | Define los argumentos para los eventos «MediaLinkStatsUpdated». |
| OpenTok.Subscriber.VideoEventArgs | Define los argumentos para los eventos «VideoEnabled» y «VideoDisabled». |
| OpenTok.Subscriber.VideoNetworkStatsEventArgs | Define los argumentos para los eventos «VideoStatsUpdated». |
| OpenTok.Subscriber.VideoQualityChangedEventArgs | Define los argumentos para los eventos «VideoQualityChanged» generados por el suscriptor. |
| OpenTok.ThreadPoolDispatcher | Implementación de IDispatcher que utiliza hilos distintos del ThreadPool gestionado para enviar eventos. Disponible para todos los marcos de presentación (WinForms, WPF, etc.). Importante: no se garantiza el orden de envío. Todas las instancias de ThreadPoolDispatcher envían eventos al mismo grupo de hilos, por lo que |
| OpenTok.VideoCapturer | Utiliza VideoCapturer.EnumerateDevices() para obtener una lista de los dispositivos de vídeo disponibles (cámaras). Utiliza uno de los métodos CreateVideoCapturer() de la clase VideoDevice para crear una instancia de un objeto VideoCapturer. La clase VideoCapturer implementa la interfaz System.IDisposable. Asegúrate de llamar al método Dispose() |
| OpenTok.VideoCapturer.VideoDevice | Utiliza el método VideoCapturer.EnumerateDevices() para obtener una lista de los dispositivos de vídeo disponibles en el sistema. |
| OpenTok.VideoCapturer.VideoFormat | Utiliza el método VideoDevice.ListFormats() para obtener una lista de objetos VideoFormat para un dispositivo. |
| OpenTok.AjustesDeCapturaDeVídeo | Define los parámetros que se pasan al método VideoCapturer.UpdateCaptureSettings(ref VideoCaptureSettings). |
| OpenTok.VideoFrame | Define un fotograma de vídeo para los métodos IVideoRenderer.RenderFrame(VideoFrame) e IVideoFrameConsumer.Consume(VideoFrame). |
| OpenTok.VideoRenderer | Esta implementación reproduce vídeos en un control de Windows Presentation Framework. El objeto `VideoRenderer` es una subclase de `System.Windows.Controls.Control`. Puedes añadir este elemento a tu jerarquía de vistas. |
| OpenTok.VideoTransformer | Define una transformación de vídeo que se utilizará en la matriz Publisher.VideoTransformers. |
| OpenTok.WinFormsDispatcher | Implementación de IDispatcher que utiliza el hilo principal/de interfaz de usuario de Windows Forms para distribuir eventos. Disponible únicamente para aplicaciones de Windows Forms. Se garantiza el orden de entrega. Todas las instancias de WinFormsDispatcher distribuyen eventos al hilo principal de la aplicación, por lo que no importa si el mismo WinForms |
| OpenTok.WPFDispatcher | Implementación de IDispatcher que utiliza el hilo principal/de la interfaz de usuario de WPF para distribuir eventos. Disponible únicamente para aplicaciones WPF. Se garantiza el orden de entrega. Todas las instancias de WPFDispatcher distribuyen eventos al hilo principal de la aplicación, por lo que no importa si siempre se utiliza el mismo WPFDispatcher o un |
| WinFormsRenderer | Enumeraciones a nivel de espacio de nombres y delegados del espacio de nombres WinFormsRenderer. |
| WinFormsRenderer.WinFormsVideoRenderer | La clase WinFormsRenderer.WinFormsVideoRenderer. |