OpenTok Linux SDK reference
The OpenTok Linux SDK includes the following header files and data structures:
| Name | Description |
|---|---|
| audio_data.h | This file includes the type definition for an audio data. Data structures: otc_audio_data Includes: stddef.h, config.h |
| audio_device.h | This file includes the type definition for an audio device, along with structures and functions you use with it. Use an audio device to define a custom audio capturer for all publishers and a custom audio renderer for all publishers and subscribers. If you do not use a custom audio device, the appli |
| audio_module_input_device.h | Audio module input device. Includes: stdlib.h, config.h, base.h |
| audio_module_output_device.h | Audio module output device. Includes: stdlib.h, config.h, base.h |
| base.h | This file includes functions uses to initialize and destroy the library engine, as well as other functions to enable console logging. Data structures: otc_on_mute_forced_info, otc_transport_stats Includes: config.h |
| camera_capture_resolution.h | This file includes the type definition for camera capture resolutions on default video capturers. |
| connection.h | This file includes the type definition for a connection structure, representing a client connected to an OpenTok session, along with several function declarations related to client connections. Includes: config.h, base.h |
| media_transformer.h | This file includes functions for working with custom media transformers and Vonage Media Processor library transformers. For more informmation, see this developer guide. Note: This functionality only applies to the Vonage Video API macOS SDK. It does not work in the Vonage Video API Linux SDK. Inclu |
| media_utils.h | This file includes an otc_media_utils_get_supported_codecs(otc_media_utils_codecs** supported_codecs) function, which you can use to find the video codecs supported on the device. Data structures: otc_media_utils_codecs Includes: base.h, config.h |
| otc_audio_data | This struct represents subscriber PCM audio data, reported periodically by the otc_subscriber_callbacks.on_audio_data callback function. |
| otc_audio_device_callbacks | This structure includes a set of function pointers to callback functions to use with an audio device. The SDK calls these functions when events related to the audio device occur. All callbacks will not be made on the application or main thread but on an internal thread. The application should return |
| otc_audio_device_settings | This structure represents the settings associated with an audio device. |
| otc_custom_ice_config | ICE server configuration. This struct represents the ICE server configuration for a given session. This is part of the configurable TURN feature. |
| otc_media_utils_codecs | A structure representing the supported codecs for encoding and decoding video. Media codecs type definition. A type representing which video codecs are supported on the device. |
| otc_on_mute_forced_info | Type definition additional details to be provided in the otc_session_callbacks.on_mute_forced function. |
| otc_publisher_audio_stats | Publisher audio stats. This structure represents the publisher audio stats. The otc_publisher_callbacks struct includes a function pointer to an on_audio_stats function, which is called periodically to report audio stats. |
| otc_publisher_callbacks | Publisher callback functions. This structure is a set of function pointers to callback functions that can be called in response to events related to an OpenTok publisher. All callbacks will not be made on the application or main thread but on an internal thread. The application should return the cal |
| otc_publisher_media_link_stats | Publisher media link statistics. This structure represents the publisher media link statistics, providing a unified view of the transport-level network conditions. Since video and audio share the same underlying transport, this struct consolidates the local transport statistics into a single object. |
| otc_publisher_rtc_stats | Represents RTC statistics for a media stream published by the publisher. |
| otc_publisher_rtc_stats_report_cb | Defines the struct for setting the publisher RTC stats report callack. |
| otc_publisher_video_layer_stats | Represents the statistics for a single published video layer. In a simulcast configuration, each entry corresponds to one independent video encoding (e.g., low, medium, high resolution streams sent in parallel). For SVC (Scalable Video Coding), the publisher typically sends a single video encoding, |
| otc_publisher_video_stats | Publisher video stats. This structure represents the publisher video stats. The otc_publisher_callbacks struct includes a function pointer to an on_video_stats function, which is called periodically to report video stats. |
| otc_session_callbacks | Session callback functions. This struct is a set of function pointers to callback functions for events related to an OpenTok session. All callbacks will not be made on the application or main thread but on an internal thread. The application should return the callback as quickly as possible to avoid |
| otc_session_capabilities | Session capabilities. This struct represents the capabilities for a client in a given session. |
| otc_signal_options | Session signal options. This struct represents options associated with an OpenTok signal. See otc_session_send_signal_with_options and otc_session_send_signal_to_connection_with_options. |
| otc_subscriber_audio_stats | This struct represents subscriber audio stats, reported periodically by the otc_subscriber_callbacks.on_audio_stats callback function. |
| otc_subscriber_callbacks | Subscriber callback functions. This struct is a set of function pointers to functions that can be invoked for events related to an OpenTok subscriber. All callbacks will not be made on the application or main thread but on an internal thread. The application should return the callback as quickly as |
| otc_subscriber_media_link_stats | This struct represents subscriber media link statistics, providing a unified view of the transport-level network conditions for a subscriber. Since audio and video share the same underlying transport, this struct consolidates the local transport, remote publisher transport, and network degradation s |
| otc_subscriber_rtc_stats_report_cb | Defines the struct for setting the subcriber RTC stats report callack. |
| otc_subscriber_video_stats | This struct represents subscriber video stats, reported periodically by the otc_subscriber_callbacks.on_video_stats callback function. Data passed into a callback function (other than subscriber and user_data) will be released after the callback is called. Make a copy of the data if you need to reta |
| otc_transport_stats | Provides network-level transport statistics. The otc_transport_stats struct exposes metrics related to the underlying network transport layer of a WebRTC connection. These stats reflect current conditions such as estimated available bandwidth and can be used for monitoring or debugging network perfo |
| otc_video_capturer_callbacks | Audio device callback functions. This struct is a set of function pointers to callback functions for events related to a video capturer. All callbacks will not be made on the application or main thread but on an internal thread. The application should return the callback as quickly as possible to av |
| otc_video_capturer_settings | Video capturer settings. This struct represents the settings associated with a video capturer. |
| otc_video_frame_planar_memory_callbacks | Defines a struct containing callback functions for a video frame plane memory wrapper struct. |
| publisher.h | This file includes the type definition for an OpenTok publisher along with several function declarations. Data structures: otc_publisher_video_layer_stats, otc_publisher_audio_stats, otc_publisher_video_stats, otc_publisher_media_link_stats, otc_publisher_callbacks, otc_publisher_rtc_stats, otc_publ |
| session.h | This file includes the type definition for an OpenTok session along with several function declarations useful when dealing with a session. Data structures: otc_session_capabilities, otc_custom_ice_config, otc_signal_options, otc_session_callbacks Includes: capabilities.h, config.h, publisher.h, subs |
| stream.h | This file includes the type definition for an audio-video stream along with several function declarations useful when handling it. Includes: config.h, connection.h |
| subscriber.h | This file includes the type definition for an OpenTok subscriber along with several function declarations. Data structures: otc_subscriber_audio_stats, otc_subscriber_video_stats, otc_subscriber_media_link_stats, otc_subscriber_rtc_stats_report_cb, otc_subscriber_callbacks Includes: audio_data.h, ba |
| video_capturer.h | This file includes the type definition for a video capturer along with several function declarations useful when working with it. Data structures: otc_video_capturer_settings, otc_video_capturer_callbacks Includes: config.h, video_frame.h |
| video_frame.h | This file includes the type definition for a video frame along with several function declarations useful when handling them. Data structures: otc_video_frame_planar_memory_callbacks Includes: unistd.h, base.h, config.h |