Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

publisher.h File Reference

OpenTok Publisher. More...

#include "config.h"
#include "stream.h"
#include "video_frame.h"

Data Structures

struct  otc_publisher_audio_stats
struct  otc_publisher_video_stats
struct  otc_publisher_callbacks
struct  otc_publisher_rtc_stats
struct  otc_publisher_rtc_stats_report_cb

Typedefs

typedef struct otc_publisher otc_publisher
typedef struct otc_publisher_settings otc_publisher_settings

Enumerations

enum  otc_publisher_error_code {
  OTC_PUBLISHER_INTERNAL_ERROR = 2000, OTC_PUBLISHER_SESSION_DISCONNECTED, OTC_PUBLISHER_TIMED_OUT = 1541, OTC_PUBLISHER_UNABLE_TO_PUBLISH = 1500,
  OTC_PUBLISHER_WEBRTC_ERROR = 1610
}
enum  otc_publisher_video_type { OTC_PUBLISHER_VIDEO_TYPE_CAMERA = 1, OTC_PUBLISHER_VIDEO_TYPE_SCREEN = 2 }

Functions

otc_publisherotc_publisher_new (const char *name, const struct otc_video_capturer_callbacks *capturer, const struct otc_publisher_callbacks *callbacks)
otc_publisher_settingsotc_publisher_settings_new ()
otc_status otc_publisher_settings_delete (otc_publisher_settings *settings)
otc_status otc_publisher_settings_set_name (otc_publisher_settings *settings, const char *name)
otc_status otc_publisher_settings_set_video_capturer (otc_publisher_settings *settings, const struct otc_video_capturer_callbacks *capturer)
otc_status otc_publisher_settings_set_audio_track (otc_publisher_settings *settings, otc_bool enabled)
otc_status otc_publisher_settings_set_video_track (otc_publisher_settings *settings, otc_bool enabled)
otc_status otc_publisher_settings_set_stereo (otc_publisher_settings *settings, otc_bool enabled)
otc_publisherotc_publisher_new_with_settings (const struct otc_publisher_callbacks *callbacks, otc_publisher_settings *settings)
otc_status otc_publisher_delete (otc_publisher *publisher)
otc_streamotc_publisher_get_stream (otc_publisher *publisher)
otc_status otc_publisher_set_publish_video (otc_publisher *publisher, otc_bool publish_video)
otc_status otc_publisher_set_publish_audio (otc_publisher *publisher, otc_bool publish_audio)
otc_bool otc_publisher_get_publish_video (const otc_publisher *publisher)
otc_bool otc_publisher_get_publish_audio (const otc_publisher *publisher)
otc_sessionotc_publisher_get_session (const otc_publisher *publisher)
otc_status otc_publisher_set_max_audio_bitrate (otc_publisher *publisher, uint32_t bitrate)
otc_status otc_publisher_set_rtc_stats_report_cb (otc_publisher *publisher, const struct otc_publisher_rtc_stats_report_cb cb)
otc_status otc_publisher_get_rtc_stats_report (const otc_publisher *publisher)
otc_status otc_publisher_set_audio_fallback_enabled (otc_publisher *publisher, otc_bool enabled)
otc_bool otc_publisher_get_audio_fallback_enabled (const otc_publisher *publisher)
const char * otc_publisher_get_publisher_id (const otc_publisher *publisher)
otc_status otc_publisher_set_video_type (struct otc_publisher *publisher, enum otc_publisher_video_type video_type)
enum otc_publisher_video_type otc_publisher_get_video_type (const struct otc_publisher *publisher)
void * otc_publisher_get_user_data (const struct otc_publisher *publisher)
const char * otc_publisher_get_name (const struct otc_publisher *publisher)

Detailed Description

OpenTok Publisher.

This file includes the type definition for an OpenTok publisher along with several function declarations.

Typedef Documentation

◆ otc_publisher

typedef struct otc_publisher otc_publisher

OpenTok publisher type definition.

A type representing a publisher of an audio-video stream to an OpenTok session.

◆ otc_publisher_settings

OpenTok publisher settings type definition.

Enumeration Type Documentation

◆ otc_publisher_error_code

Error code enumeration for OpenTok publishers.

This enumeration represents several error codes associated with a publisher.

Enumerator
OTC_PUBLISHER_INTERNAL_ERROR 

Internal error.

OTC_PUBLISHER_SESSION_DISCONNECTED 

Error attempting to a session that you are not connected to.

OTC_PUBLISHER_TIMED_OUT 

Time-out attempting to publish.

OTC_PUBLISHER_UNABLE_TO_PUBLISH 

Unable to publish error.

OTC_PUBLISHER_WEBRTC_ERROR 

WebRTC error.

◆ otc_publisher_video_type

Publisher video type enumeration.

This enumeration represents the different video types supported.

Enumerator
OTC_PUBLISHER_VIDEO_TYPE_CAMERA 

Camera video stream.

OTC_PUBLISHER_VIDEO_TYPE_SCREEN 

Screen capture video stream.

Function Documentation

◆ otc_publisher_delete()

otc_status otc_publisher_delete ( otc_publisher publisher)

Releases a publisher instance, including all hardware resources bound to it.

Parameters
publisherThe publisher instance to be deleted.
Returns
Return value indicating either error or success.

◆ otc_publisher_get_audio_fallback_enabled()

otc_bool otc_publisher_get_audio_fallback_enabled ( const otc_publisher publisher)

Returns whether the publisher audio fallback feature is enabled or not. See the otc_publisher_set_audio_fallback_enabled function.

Parameters
publisherThe publisher instance.
Returns
Whether the publisher audio fallback feature is enabled or not.

◆ otc_publisher_get_name()

const char* otc_publisher_get_name ( const struct otc_publisher publisher)

Gets the name for a given publisher.

Parameters
publisherThe publisher instance.
Returns
The name.

◆ otc_publisher_get_publish_audio()

otc_bool otc_publisher_get_publish_audio ( const otc_publisher publisher)

Returns whether the Publisher is publishing audio or not.

Parameters
publisherThe publisher instance.
Returns
Whether the publisher is publishing audio or not.

◆ otc_publisher_get_publish_video()

otc_bool otc_publisher_get_publish_video ( const otc_publisher publisher)

Returns whether the publisher is publishing video or not.

Parameters
publisherThe publisher instance.
Returns
Whether the publisher is publishing video or not.

◆ otc_publisher_get_publisher_id()

const char* otc_publisher_get_publisher_id ( const otc_publisher publisher)

Gets a unique identifier for a publisher.

Parameters
publisherThe publisher instance.
Returns
A unique identifier for the publisher. If there is an error, this is null.

◆ otc_publisher_get_rtc_stats_report()

otc_status otc_publisher_get_rtc_stats_report ( const otc_publisher publisher)

Gets the RTC stats report for the subscriber. This is an asynchronous operation. create an otc_publisher_rtc_stats_report_cb struct and pass it into the otc_publisher_set_rtc_stats_report_cb function prior to calling this function. When the stats are available, the otc_publisher_set_rtc_stats_report_cb callback function is called.

Also see otc_publisher_callbacks.on_audio_stats, otc_publisher_callbacks.on_video_stats, and otc_subscriber_get_rtc_stats_report.

Parameters
publisherThe publisher.

◆ otc_publisher_get_session()

otc_session* otc_publisher_get_session ( const otc_publisher publisher)

Returns the otc_session associated this publisher instance.

Parameters
publisherThe publisher instance.
Returns
The otc_session associated this instance. If there is an error, this is null.

◆ otc_publisher_get_stream()

otc_stream* otc_publisher_get_stream ( otc_publisher publisher)

Returns the stream associated with the publisher.

Parameters
publisherThe publisher instance to get the stream from.
Returns
The stream associated with the publisher. If there is an error, this is null.

◆ otc_publisher_get_user_data()

void* otc_publisher_get_user_data ( const struct otc_publisher publisher)

Gets user data for a given publisher.

Parameters
publisherThe publisher instance.
Returns
A pointer to the user data in memory.

◆ otc_publisher_get_video_type()

enum otc_publisher_video_type otc_publisher_get_video_type ( const struct otc_publisher publisher)

Gets the publisher video type. See the otc_publisher_set_video_type function.

Parameters
publisherThe publisher instance.
Returns
The publisher video type.

◆ otc_publisher_new()

otc_publisher* otc_publisher_new ( const char *  name,
const struct otc_video_capturer_callbacks capturer,
const struct otc_publisher_callbacks callbacks 
)

Creates a new otc_publisher instance.

Parameters
nameThe name of the publisher. Other clients can get the names for streams in the session.
capturerUse this parameter if you want to provide a custom video capturer. If it is set to null, the publisher uses a default video capturer using the system's camera.
callbacksA pointer to the structure with the publisher callback function pointers.
Returns
A new otc_publisher instance. If there is an error, this is null.

◆ otc_publisher_new_with_settings()

otc_publisher* otc_publisher_new_with_settings ( const struct otc_publisher_callbacks callbacks,
otc_publisher_settings settings 
)

Creates a new otc_publisher instance.

Parameters
callbacksA pointer to the struct with publisher callback function pointers.
settingsThe settings struct containing the desired settings for the publisher.
Returns
A new otc_publisher instance. If there is an error, this is null.

◆ otc_publisher_set_audio_fallback_enabled()

otc_status otc_publisher_set_audio_fallback_enabled ( otc_publisher publisher,
otc_bool  enabled 
)

Enables or disables the audio fallback feature.

The audio-fallback feature is available in sessions that use the OpenTok Media Router. With the audio-fallback feature enabled (the default), when the OpenTok Media Router determines that a stream's quality has degraded significantly for a specific subscriber to the stream, it disables the video in that subscriber in order to preserve audio quality.

To turn off the audio-fallback feature, call the otc_publisher_set_audio_fallback_enabled function (and pass in OTC_FALSE) before calling the otc_session_publish function.

Parameters
publisherThe publisher to be affected.
enabledWhether we want to enable the audio fallback feature or not.
Returns
Return value indicating either error or success.

◆ otc_publisher_set_max_audio_bitrate()

otc_status otc_publisher_set_max_audio_bitrate ( otc_publisher publisher,
uint32_t  bitrate 
)

Sets the max audio bitrate for the publisher.

Parameters
publisherThe publisher to be affected.
bitrateThe desired bitrate.
Returns
Return value indicating either error or success.

◆ otc_publisher_set_publish_audio()

otc_status otc_publisher_set_publish_audio ( otc_publisher publisher,
otc_bool  publish_audio 
)

Whether to publish audio or not. By default, streams publish both audio and video.

Parameters
publisherThe publisher to be affected.
publish_audioWhether to publish audio or not.
Returns
Return value indicating either error or success.

◆ otc_publisher_set_publish_video()

otc_status otc_publisher_set_publish_video ( otc_publisher publisher,
otc_bool  publish_video 
)

Whether to publish video or not. By default, streams publish both audio and video.

Parameters
publisherThe publisher to be affected.
publish_videoWhether to publish video or not.
Returns
Return value indicating either error or success.

◆ otc_publisher_set_rtc_stats_report_cb()

otc_status otc_publisher_set_rtc_stats_report_cb ( otc_publisher publisher,
const struct otc_publisher_rtc_stats_report_cb  cb 
)

Sets the RTC stats report callback the publisher.

Parameters
subscriberThe subscriber instance.
cbThe otc_publisher_rtc_stats_report_cb struct that includes the callback function for the RTC stats report.
See also
otc_publisher_get_rtc_stats_report.

◆ otc_publisher_set_video_type()

otc_status otc_publisher_set_video_type ( struct otc_publisher publisher,
enum otc_publisher_video_type  video_type 
)

Sets the publisher video type. By default, videos have the video type set to OTC_PUBLISHER_VIDEO_TYPE_CAMERA (indicating the source of the video is a camera). Set this to OTC_PUBLISHER_VIDEO_TYPE_SCREEN to indicate that the video source is screen sharing. Other clients can detect the video type for streams in the session (to determine the video source type).

Parameters
publisherThe publisher to be affected.
video_typeThe video type for the publisher.
Returns
Return value indicating either error or success.

◆ otc_publisher_settings_delete()

otc_status otc_publisher_settings_delete ( otc_publisher_settings settings)

Deletes an otc_publisher_settings instance.

Parameters
settingsThe otc_publisher_settings instance to be deleted.
Returns
Return value indicating either error or success.

◆ otc_publisher_settings_new()

otc_publisher_settings* otc_publisher_settings_new ( )

Creates a new otc_publisher_settings instance.

Returns
A new otc_publisher_settings instance

◆ otc_publisher_settings_set_audio_track()

otc_status otc_publisher_settings_set_audio_track ( otc_publisher_settings settings,
otc_bool  enabled 
)

Enables an audio track for a publisher to be constructed with otc_publisher_new_with_settings.

Parameters
settingsThe otc_publisher_settings instance to be affected.
enabledEnable/disable the existence of an audio track for a publisher to be constructed with {}. Return value indicating either error or success.

◆ otc_publisher_settings_set_name()

otc_status otc_publisher_settings_set_name ( otc_publisher_settings settings,
const char *  name 
)

Sets the desired name for a publisher to be constructed with otc_publisher_new_with_settings.

Parameters
settingsThe otc_publisher_settings instance to be affected.
nameThe name for the publisher. Other clients can get the names for streams in the session.
Returns
Return value indicating either error or success.

◆ otc_publisher_settings_set_stereo()

otc_status otc_publisher_settings_set_stereo ( otc_publisher_settings settings,
otc_bool  enabled 
)

Enables stereo audio for a publisher to be constructed with otc_publisher_new_with_settings.

Parameters
settingsThe otc_publisher_settings instance to be affected.
enabledEnable/disable stereo audio support for a publisher to be constructed with {}. Return value indicating either error or success.

◆ otc_publisher_settings_set_video_capturer()

otc_status otc_publisher_settings_set_video_capturer ( otc_publisher_settings settings,
const struct otc_video_capturer_callbacks capturer 
)

Sets the video capturer for a publisher to be constructed with otc_publisher_new_with_settings.

Parameters
settingsThe otc_publisher_settings instance to be affected.
capturerThe video capturer.
Returns
Return value indicating either error or success.

◆ otc_publisher_settings_set_video_track()

otc_status otc_publisher_settings_set_video_track ( otc_publisher_settings settings,
otc_bool  enabled 
)

Enables a video track for a publisher to be constructed with otc_publisher_new_with_settings.

Parameters
settingsThe otc_publisher_settings instance to be affected.
enabledEnable/disable the existence of an video track for a publisher to be constructed with {}. Return value indicating either error or success.