OpenTok-Sitzung. Mehr...

#include "capabilities.h" #include "config.h" #include "publisher.h" #include "subscriber.h" #include "stream.h"
Makros
#define ENCRYPTION_SECRET_MINIMUM_LENGTH   8
#define ENCRYPTION_SECRET_MAXIMUM_LENGTH   256
Typdefinitionen
typedef struct otc_session otc_session
typedef struct otc_session_settings otc_session_settings
Aufzählungen
enum otc_session_error_code {   OTC_SESSION_AUTHORIZATION_FAILURE , OTC_SESSION_BLOCKED_COUNTRY , OTC_SESSION_CONNECTION_DROPPED , OTC_SESSION_CONNECTION_FAILED ,   OTC_SESSION_CONNECTION_LIMIT_EXCEEDED , OTC_SESSION_CONNECTION_REFUSED , OTC_SESSION_CONNECTION_TIMED_OUT , OTC_SESSION_FORCE_UNPUBLISH_OR_INVALID_STREAM = 1535 ,   OTC_SESSION_ILLEGAL_STATE , OTC_SESSION_INTERNAL_ERROR , OTC_SESSION_INVALID_SESSION , OTC_SESSION_INVALID_SIGNAL_TYPE ,   OTC_SESSION_NOT_CONNECTED , OTC_SESSION_NO_MESSAGING_SERVER , OTC_SESSION_NULL_OR_INVALID_PARAMETER , OTC_SESSION_PUBLISHER_NOT_FOUND ,   OTC_SESSION_SIGNAL_DATA_TOO_LONG , OTC_SESSION_SIGNAL_TYPE_TOO_LONG , OTC_SESSION_UNABLE_TO_SEND_SIGNAL , OTC_SESSION_STATE_FAILED = 1020 ,   OTC_SESSION_SUBSCRIBER_NOT_FOUND , OTC_SESSION_UNEXPECTED_GET_SESSION_INFO_REPONSE , OTC_SESSION_ENCRYPTION_SECRET_MISSING , OTC_SESSION_INVALID_ENCRYPTION_SECRET }
Funktionen
otc_session * otc_session_new (const char *apikey, const char *session_id, const struct otc_session_callbacks *Callbacks)
otc_session_settings * otc_session_settings_new (void)
otc_status otc_session_settings_set_connection_events_suppressed (otc_session_settings *Einstellungen, otc_bool unterdrücken)
otc_status otc_session_settings_set_custom_ice_config (otc_session_settings *Einstellungen, const struct otc_custom_ice_config *custom_ice_config)
otc_status otc_session_settings_set_proxy_url (otc_session_settings *Einstellungen, const char *proxy_url)
otc_status otc_session_settings_set_ip_whitelist (otc_session_settings *Einstellungen, otc_bool ip_whitelist)
otc_status otc_session_settings_set_single_peer_connection (otc_session_settings *Einstellungen, otc_bool aktivieren)
Aktiviert oder deaktiviert die Single-Peer-Verbindung (SPC) für eine Sitzung. Mehr...
otc_status otc_session_settings_set_session_migration (otc_session_settings *Einstellungen, otc_bool aktivieren)
Aktiviert oder deaktiviert die Sitzungsmigration für eine Sitzung. Mehr...
otc_status otc_session_settings_delete (otc_session_settings *Einstellungen)
otc_session * otc_session_new_with_settings (const char *apikey, const char *session_id, const struct otc_session_callbacks *Callbacks, otc_session_settings *Einstellungen)
otc_status otc_session_delete (otc_session *Sitzung)
otc_status otc_session_connect (otc_session *session, const char *token)
otc_status otc_session_disconnect (otc_session *Sitzung)
otc_status otc_session_publish (otc_session *Sitzung, otc_publisher *Verlag)
otc_status otc_session_unpublish (otc_session *Sitzung, otc_publisher *Verlag)
otc_status otc_session_subscribe (otc_session *Sitzung, otc_Abonnent *Abonnent)
otc_status otc_session_unsubscribe (otc_session *Sitzung, otc_Abonnent *Abonnent)
otc_status otc_session_send_signal (otc_session *session, const char *type, const char *signal)
otc_status otc_session_force_mute_all (otc_session *session, const char **excluded_streams_ids, const int excluded_streams_len)
otc_status otc_session_disable_force_mute (otc_session *Sitzung)
otc_status otc_session_force_mute_stream (const otc_session *session, const char *stream_id_to_mute)
otc_status otc_session_force_disconnect (const otc_session *session, const otc_connection *Verbindung)
otc_status otc_session_send_signal_to_connection (otc_session *session, const char *type, const char *signal, const otc_connection *Verbindung)
otc_status otc_session_send_signal_with_options (otc_session *session, const char *type, const char *signal, struct otc_signal_options signal_options)
otc_status otc_session_send_signal_to_connection_with_options (otc_session *session, const char *type, const char *signal, const otc_connection *Verbindung, Struktur otc_signal_options signal_options)
otc_status otc_session_report_issue (struct otc_session *session, const char *issue_description, char **issue_id)
char * otc_session_get_id (const otc_session *Sitzung)
otc_connection * otc_session_get_connection (const otc_session *Sitzung)
struct otc_session_capabilities otc_session_get_capabilities (const otc_session *Sitzung)
void * otc_session_get_user_data (const otc_session *Sitzung)
otc_status otc_session_set_encryption_secret (otc_session *session, const char *secret)
Legt den Schlüssel für die End-to-End-Verschlüsselung fest, der von allen Herausgebern und Abonnenten in der Sitzung verwendet wird. Mehr...

Ausführliche Beschreibung

OpenTok-Sitzung.

Diese Datei enthält die Typdefinition für eine OpenTok-Sitzung sowie mehrere Funktionsdeklarationen, die bei der Arbeit mit einer Sitzung nützlich sind.

Typedef-Dokumentation

otc_session
typedef struct otc_session otc_session

Definition des OpenTok-Sitzungstyps.

otc_session_settings

Typdefinition für OpenTok-Sitzungseinstellungen.

Dokumentation zu Aufzählungstypen

otc_session_error_code

Auflistung der Fehlercodes für OpenTok-Sitzungen.

Diese Aufzählung enthält verschiedene Fehlercodes, die mit einer Sitzung in Verbindung stehen.

Zähler
OTC_SESSION_AUTHORIZATION_FAILURE Es wurde ein ungültiger API-Schlüssel oder ein ungültiges Token angegeben.
OTC_SESSION_BLOCKED_COUNTRY Die Verbindung zur Sitzung konnte nicht hergestellt werden. Verstoß gegen die Nutzungsbedingungen: Exportvorschriften.
OTC_SESSION_CONNECTION_DROPPED Die Verbindung zum OpenTok-Messaging-Server wurde unterbrochen.
OTC_SESSION_CONNECTION_FAILED Die Verbindung zur Sitzung konnte nicht hergestellt werden.
OTC_SESSION_CONNECTION_LIMIT_EXCEEDED Der Client hat versucht, eine Verbindung zu einer Sitzung herzustellen, bei der das Limit für gleichzeitige Verbindungen überschritten wurde.
OTC_SESSION_CONNECTION_REFUSED Es konnte keine Verbindung zum Messaging-Server hergestellt werden. Bitte überprüfen Sie, ob die ausgehenden Ports 443 und 8080 erreichbar sind.
OTC_SESSION_CONNECTION_TIMED_OUT Beim Versuch, eine Verbindung zur Sitzung herzustellen, ist die Zeitüberschreitung aufgetreten.
OTC_SESSION_FORCE_UNPUBLISH_OR_INVALID_STREAM Ungültiger Stream.
OTC_SESSION_ILLEGAL_STATE Eine Methode wurde zu einem für diese Sitzung unzulässigen oder ungeeigneten Zeitpunkt aufgerufen. Dieser Fehler tritt beispielsweise auf, wenn versucht wird, eine Verbindung zu einer bereits bestehenden Sitzung herzustellen.
OTC_SESSION_INTERNAL_ERROR Fehler beim Thread-Start, Speichermangel, Parsing-Fehler usw.
OTC_SESSION_INVALID_SESSION Es wurde eine ungültige Sitzungs-ID angegeben.
OTC_SESSION_INVALID_SIGNAL_TYPE Sie haben versucht, ein Signal mit einem ungültigen Typ zu senden.
OTC_SESSION_NOT_CONNECTED Die Sitzung ist nicht verbunden, und für die angeforderte Aktion ist eine aktive Sitzungsverbindung erforderlich.
OTC_SESSION_NO_MESSAGING_SERVER Für diese Sitzung steht kein Messaging-Server zur Verfügung.
OTC_SESSION_NULL_OR_INVALID_PARAMETER Ein übergebener Parameter ist null oder ungültig.
OTC_SESSION_PUBLISHER_NOT_FOUND Der Herausgeber ist dieser Sitzung unbekannt. Dies ist in der Regel die Folge eines Versuchs, einen Herausgeber zu deaktivieren, der nicht mit der Sitzung verknüpft ist.
OTC_SESSION_SIGNAL_DATA_TOO_LONG Sie haben versucht, ein Signal mit einer Datenfolge zu senden, die die maximale Länge (8 KB) überschreitet.
OTC_SESSION_SIGNAL_TYPE_TOO_LONG Sie haben versucht, ein Signal mit einer Typzeichenfolge zu senden, deren Länge die maximale Länge überschreitet.
OTC_SESSION_UNABLE_TO_SEND_SIGNAL Das Signal konnte nicht erfolgreich gesendet werden, möglicherweise aufgrund fehlender Berechtigungen (z. B. eines Tokens, das nur für Publisher bestimmt ist).
OTC_SESSION_STATE_FAILED Beim Versuch, den Status der Sitzung abzurufen, ist die Verbindung abgelaufen.
OTC_SESSION_SUBSCRIBER_NOT_FOUND Der Abonnent ist dieser Sitzung unbekannt. Dies ist in der Regel darauf zurückzuführen, dass versucht wurde, einen Abonnenten abzumelden, der nicht mit der Sitzung verknüpft ist.
OTC_SESSION_UNEXPECTED_GET_SESSION_INFO_REPONSE Unerwartete Reaktion.
OTC_SESSION_ENCRYPTION_SECRET_MISSING Es wurde versucht, einer durchgehend verschlüsselten Sitzung ohne Verschlüsselungsschlüssel beizutreten.
OTC_SESSION_INVALID_ENCRYPTION_SECRET Es wurde versucht, einer durchgehend verschlüsselten Sitzung ohne Verschlüsselungsschlüssel beizutreten.

Funktionsdokumentation

otc_session_connect()
otc_status otc_session_connect ( otc_session * Sitzung,
const char * Token
)

Verbindet den Client mit einer OpenTok-Sitzung.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung darstellt, mit der eine Verbindung hergestellt werden soll. | | token | Das Client-Token für die Verbindung mit der Sitzung. Siehe Token-Erstellung Übersicht. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_delete()
otc_status otc_session_delete ( otc_session * Sitzung )

Gibt die mit der Sitzung verbundenen Ressourcen frei. Keine Callbacks in otc_session_callbacks wird infolge des Aufrufs dieser Methode (oder danach) aufgerufen.

Parameter : | | | | --- | --- | | session | Die otc_session Beispiel. |

otc_session_disable_force_mute()
otc_status otc_session_disable_force_mute ( otc_session * Sitzung )

Hebt den aktiven Stummschaltungsstatus der Sitzung auf. Nachdem Sie diese Methode aufgerufen haben, wird der Ton bei neuen Streams, die in der Sitzung veröffentlicht werden, nicht mehr stummgeschaltet.

Nachdem Sie die otc_session_force_mute_all() Funktion (oder wenn ein Moderator in einem anderen Client einen Befehl zum Stummschalten aller Streams erteilt), werden alle Streams, die nach dem Moderationsbefehl veröffentlicht werden, mit stummgeschaltetem Ton veröffentlicht. Rufen Sie die otc_session_disable_force_mute Funktion zum Aufheben der Stummschaltung einer Sitzung (damit neu veröffentlichte Streams nicht automatisch stummgeschaltet werden).

Der Aufruf dieser Funktion bewirkt, dass die otc_session_callback.on_mute_forced() Callback-Funktion, die bei jedem mit der Sitzung verbundenen Client aufgerufen werden soll, mit der active Eigenschaft der otc_on_mute_forced_info Die an die Funktion übergebene Struktur ist auf OTC_FALSE.

Rufen Sie die otc_session_get_capabilities Funktion, um zu prüfen, ob der Client diese Funktion erfolgreich aufrufen kann. Diese Funktion ist Clients vorbehalten, die sich mit einem Token verbunden haben, dem die Moderatorenrolle zugewiesen wurde (siehe die Übersicht über die Token-Erstellung.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_disconnect()
otc_status otc_session_disconnect ( otc_session * Sitzung )

Trennt den Client von dieser Sitzung. Alle Abonnenten und Publisher des Clients werden ebenfalls von der Sitzung getrennt. Es wird empfohlen, vor dem Aufruf dieser Funktion zunächst die Funktion otc_session_unpublish Funktion für alle Herausgeber und warte auf die otc_publisher_callbacks#on_stream_destroyed Callback. Dies gewährleistet die vollständige Entfernung von Publishern, insbesondere wenn Probleme mit der Netzwerkverbindung die Entfernung aufgrund der Wiederverbindungsfunktion verhindern, die Publisher-Streams für eine mögliche Wiederverbindung aufrechterhalten könnte.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert, von der die Verbindung getrennt werden soll. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_force_disconnect()
otc_status otc_session_force_disconnect ( const otc_session * Sitzung,
const otc_connection * Verbindung
)

Zwingt einen Client, die Verbindung zur Sitzung zu trennen.

Sie können diese Funktion zwar verwenden, um Ihre eigene Verbindung zu beenden, doch der Aufruf von otc_session_disconnect ist einfacher. Es wird ein Fehler zurückgegeben, wenn die Rolle des Clients nicht über die erforderlichen Berechtigungen verfügt, um andere Benutzer zur Trennung der Verbindung zu zwingen. Die Rolle eines Clients legen Sie beim Erstellen des Benutzer-Tokens fest. Wenn eine Verbindung mithilfe dieser Funktion beendet wird, otc_session_callbacks#on_connection_dropped und otc_publisher_callbacks#on_stream_destroyed Callbacks werden genauso ausgelöst, als hätte die Verbindung selbst mit otc_session_disconnect.

Parameter : | | | | --- | --- | | session | Die otc_session, zu der die Verbindung gehört | | connection | Die Verbindung, die getrennt werden soll |

Rückgabewerte : Im Fehlerfall wird ein Fehler zurückgegeben, andernfalls OTC_SUCCESS

otc_session_force_mute_all()
otc_status otc_session_force_mute_all ( otc_session * Sitzung,
const char ** ausgeschlossene_Stream-IDs,
const int excluded_streams_len
)

Zwingt alle Sender in der Sitzung (mit Ausnahme derjenigen, die ausgeschlossene Streams übertragen), den Ton stummzuschalten.

Außerdem werden alle Streams, die nach dem Aufruf der otc_session_force_mute_all Funktion werden mit stummgeschaltetem Ton veröffentlicht. Sie können den Stummschaltzustand einer Sitzung aufheben, indem Sie die Funktion otc_session_disable_force_mute Funktion. Nachdem Sie die otc_session_disable_force_mute wird bei neuen Streams, die in der Sitzung veröffentlicht werden, der Ton nicht mehr stummgeschaltet.

Der Aufruf dieser Funktion bewirkt, dass die otc_session_callback.on_mute_forced() Callback-Funktion, die bei jedem mit der Sitzung verbundenen Client aufgerufen werden soll, mit der active Eigenschaft der otc_on_mute_forced_info Die an die Funktion übergebene Struktur ist auf OTC_TRUE. Außerdem ist die otc_publisher_callbacks.on_publisher_mute_forced() Die Callback-Funktion wird bei jedem Client aufgerufen, der einen stummgeschalteten Stream veröffentlicht.

Rufen Sie die otc_session_get_capabilities Funktion, um zu prüfen, ob der Client diese Funktion erfolgreich aufrufen kann. Diese Funktion ist Clients vorbehalten, die sich mit einem Token angemeldet haben, dem die Moderatorenrolle zugewiesen wurde (siehe (siehe Übersicht über die Token-Erstellung.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert. | | excluded_streams_ids | Ein Zeiger auf ein Array von Stream-ID-Zeichenketten für die Streams, die stummgeschaltet werden sollen. Setzen Sie diesen Wert auf nullptr, um alle Streams in der Sitzung stummzuschalten (einschließlich der vom lokalen Client veröffentlichten). | | excluded_streams_len | Die Länge des Arrays der ausgeschlossenen Streams. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_force_mute_stream()
otc_status otc_session_force_mute_stream ( const otc_session * Sitzung,
const char * stream_id_to_mute
)

Zwingt den Anbieter eines bestimmten Streams dazu, dessen Ton stummzuschalten.

Der Aufruf dieser Funktion bewirkt, dass die otc_publisher_callbacks.on_publisher_mute_forced() Callback-Funktion, die auf dem Client aufgerufen werden soll, der den stummgeschalteten Stream veröffentlicht.

Rufen Sie die otc_session_get_capabilities Funktion, um zu prüfen, ob der Client diese Funktion erfolgreich aufrufen kann. Diese Funktion ist Clients vorbehalten, die sich mit einem Token angemeldet haben, dem die Moderatorenrolle zugewiesen wurde (siehe (siehe Übersicht über die Token-Erstellung.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert. | | stream_id_to_mute | Die Stream-ID als Zeichenfolge für den Stream, der stummgeschaltet werden soll. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_get_capabilities()
struct otc_session_capabilities otc_session_get_capabilities ( const otc_session * Sitzung )

Ruft die Funktionen des mit der Sitzung verbundenen Clients ab. Alle otc_session_capabilities Die Elemente sind undefiniert, bis otc_session_callbacks.on_connected wurde aufgerufen.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert. |

Rücksendungen : Die otc_session_capabilities Instanz.

otc_session_get_connection()
otc_connection * otc_session_get_connection ( const otc_session * Sitzung )

Ruft das dieser Sitzung zugeordnete Verbindungsobjekt ab.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert. |

Rücksendungen : Die otc_connection Instanz.

otc_session_get_id()
char * otc_session_get_id ( const otc_session * Sitzung )

Ruft die eindeutige Sitzungs-ID für diese Sitzung ab.

otc_session_get_user_data()
void * otc_session_get_user_data ( const otc_session * Sitzung )

Ruft die mit der Sitzung verknüpften Benutzerdaten ab. Siehe otc_session_callbacks.user_data.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert. |

Rückgabewerte : Ein Zeiger auf die Benutzerdaten.

otc_session_new()
otc_session * otc_session_new ( const char * apikey,
const char * session_id,
const struct otc_session_callbacks * Rückrufe
)

Erstellt ein neues otc_session Strukturinstanz. Übergeben Sie diese an die otc_session_connect Funktion zum Herstellen einer Verbindung zur OpenTok-Sitzung.

Siehe auch otc_session_new_with_settings zum Initialisieren einer `otc_session`-Struktur mit erweiterten Optionen.

Parameter : | | | | --- | --- | | apikey | Der API-Schlüssel für das OpenTok-Projekt. Siehe Rufen Sie Ihren Vonage Video API-Account auf. |

Das ist wichtig: Wenn Sie die Video API mit einer Vonage-Anwendung (anstelle eines OpenTok-Projekts) verwenden, geben Sie für diesen Parameter die Anwendungs-ID (nicht einen OpenTok-API-Schlüssel) an.

Parameter : | | | | --- | --- | | session_id | Die Sitzungs-ID. | | callbacks | Die otc_session_callbacks Struktur, die Callback-Funktionen für Ereignisse im Zusammenhang mit der Sitzung enthält. |

Rückgabewerte : Die Struktur „otc_session“, die die OpenTok-Sitzung repräsentiert.

otc_session_new_with_settings()
otc_session * otc_session_new_with_settings ( const char * apikey,
const char * session_id,
const struct otc_session_callbacks * Rückrufe,
otc_session_settings * Einstellungen
)

Erstellt eine neue OpenTok-Sitzung mit erweiterten Einstellungen. Dazu gehören Einstellungen zur Unterdrückung von Verbindungsereignissen, benutzerdefinierte TURN-Server sowie die IP-Proxy- und die IP-Whitelist-Funktion.

Parameter : | | | | --- | --- | | apikey | Der API-Schlüssel für das OpenTok-Projekt. Siehe Rufen Sie Ihren Vonage Video API-Account auf. | | session_id | Die Sitzungs-ID. | | callbacks | Die otc_session_callbacks Struktur, die Callback-Funktionen für Ereignisse im Zusammenhang mit der Sitzung enthält. | | Einstellungen | Die otc_session_settings struct Mit erweiterten Einstellungen für die Sitzung. |

Rücksendungen : Die struct, das die OpenTok-Sitzung repräsentiert.

Siehe auch : otc_session_new.

otc_session_publish()
otc_status otc_session_publish ( otc_session * Sitzung,
otc_publisher * Herausgeber
)

Startet einen Publisher, der Daten an die Sitzung überträgt.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert, in die veröffentlicht werden soll. | | publisher | Der otc_publisher Struktur, die den Herausgeber repräsentiert. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_report_issue()
otc_status otc_session_report_issue ( struct otc_session * Sitzung,
const char * Problembeschreibung,
char ** issue_id
)

Melden Sie, dass bei Ihrer App ein Problem aufgetreten ist. Sie können die Problem-ID mit der Inspektor Tool oder bei der Erörterung eines Problems mit dem Support-Team der Vonage Video API.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert. | | issue_description | Eine Beschreibungszeichenfolge. | | issue_id | Ein Zeiger auf eine Zeichenfolge, die als eindeutige Kennung für das gemeldete Problem festgelegt wird. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_send_signal()
otc_status otc_session_send_signal ( otc_session * Sitzung,
const char * Typ,
const char * Signal
)

Sendet ein Signal an alle mit der Sitzung verbundenen Clients. Siehe otc_session_send_signal_with_options, otc_session_send_signal_to_connectionund otc_session_send_signal_to_connection_with_options. Siehe auch die Überblick über die Signalisierung.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert. | | type | Der optionale Typ-Zeichenfolgenwert für das Signal. | | signal | Der optionale Daten-Zeichenfolgenwert für das Signal. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_send_signal_to_connection()
otc_status otc_session_send_signal_to_connection ( otc_session * Sitzung,
const char * Typ,
const char * Signal,
const otc_connection * Verbindung
)

Sendet ein Signal an einen bestimmten Client, der mit der Sitzung verbunden ist. Siehe otc_session_send_signal_to_connection_with_options, otc_session_send_signalund otc_session_send_signal_with_options. Siehe auch die Überblick über die Signalisierung.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung darstellt. | | type | Der optionale Typ-Zeichenfolgenwert für das Signal. | | signal | Der optionale Daten-Zeichenfolgenwert für das Signal. | | connection | Die otc_connection Struktur, die dem Client entspricht, der das Signal empfangen soll. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_send_signal_to_connection_with_options()
otc_status otc_session_send_signal_to_connection_with_options ( otc_session * Sitzung,
const char * Typ,
const char * Signal,
const otc_connection * Verbindung,
struct otc_signal_options signal_options
)

Sendet ein Signal an einen bestimmten Client mit den angegebenen Optionen. Siehe otc_session_send_signal, otc_session_send_signal_to_connectionund otc_session_send_signal_with_options. Siehe auch die Überblick über die Signalisierung.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung darstellt. | | type | Der optionale Typ-Zeichenfolgenwert für das Signal. | | signal | Der optionale Daten-Zeichenfolgenwert für das Signal. | | connection | Die otc_connection Struktur, die dem Client entspricht, der das Signal empfangen soll. | | signal_options | Die otc_signal_options Struktur mit Optionen für das Signal. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_send_signal_with_options()
otc_status otc_session_send_signal_with_options ( otc_session * Sitzung,
const char * Typ,
const char * Signal,
struct otc_signal_options signal_options
)

Sendet ein Signal mit den angegebenen Optionen an alle mit der Sitzung verbundenen Clients. Siehe otc_session_send_signal, otc_session_send_signal_to_connectionund otc_session_send_signal_to_connection_with_options. Siehe auch die Überblick über die Signalisierung.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung darstellt. | | type | Der optionale Typ-Zeichenfolgenwert für das Signal. | | signal | Der optionale Daten-Zeichenfolgenwert für das Signal. | | signal_options | Die otc_signal_options Struktur mit Optionen für das Signal. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_set_encryption_secret()
otc_status otc_session_set_encryption_secret ( otc_session * Sitzung,
const char * geheim
)

Legt den Schlüssel für die End-to-End-Verschlüsselung fest, der von allen Herausgebern und Abonnenten in der Sitzung verwendet wird.

Siehe die Entwicklerhandbuch zur End-to-End-Verschlüsselung.

Parameter : | | | | | --- | --- | --- | | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert. | | [in] | secret | Wert für den Verschlüsselungsschlüssel. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_settings_delete()
otc_status otc_session_settings_delete ( otc_session_settings * Einstellungen )

Löscht ein otc_session_settings Instanz.

otc_session_settings_new()
otc_session_settings * otc_session_settings_new ( void )

Erstellt ein neues otc_session_settings Beispiel: Dient zum Festlegen erweiterter Sitzungseinstellungen. Rufen Sie die folgenden Funktionen auf, um diese Einstellungen zu konfigurieren, bevor Sie die otc_session_new_with_settings Funktion zum Erstellen einer Sitzung mit diesen Einstellungen:

  • otc_session_settings_set_connection_events_suppressed — Verbindungsereignisse unterdrücken.
  • otc_session_settings_set_custom_ice_config &mdash Benutzerdefinierte TURN-Server verwenden.
  • otc_session_settings_set_proxy_url — Konfigurieren Sie die IP-Proxy-Funktion.
  • otc_session_settings_set_ip_whitelist — Aktivieren Sie die IP-Whitelist-Funktion.
  • otc_session_settings_set_single_peer_connection — Aktivieren Sie die Funktion „Single Peer Connection“.
  • otc_session_settings_set_session_migration — Aktivieren Sie die Funktion „Sitzungsmigration“.

otc_session_settings_set_connection_events_suppressed()
otc_status otc_session_settings_set_connection_events_suppressed ( otc_session_settings * Einstellungen,
otc_bool unterdrücken
)

Verbindungsereignisse verhindern, um umfangreiche interaktive Videositzungen zu unterstützen. Dadurch wird verhindert, dass otc_session_callbacks.on_connection_created und otc_session_callbacks.on_connection_dropped Callback-Funktionen werden nicht aufgerufen, wenn andere Clients eine Verbindung zur Sitzung herstellen oder diese trennen. (Außerdem sendet der OpenTok-Server diese Ereignisse nicht an den Client.) Weitere Informationen finden Sie unter Unterdrückung von Verbindungsereignissen in den OpenTok-Entwicklerhandbüchern.

otc_session_settings_set_custom_ice_config()
otc_status otc_session_settings_set_custom_ice_config ( otc_session_settings * Einstellungen,
const struct otc_custom_ice_config * custom_ice_config
)

Ermöglicht eine benutzerdefinierte Konfiguration des ICE-Servers. Dies ist Teil der konfigurierbare TURN-Funktion.

otc_session_settings_set_ip_whitelist()
otc_status otc_session_settings_set_ip_whitelist ( otc_session_settings * Einstellungen,
otc_bool ip_whitelist
)

Übergeben Sie „OTC_TRUE“, damit der Client die IP-Adressen-Whitelist verwendet. Diese Funktion ist als Zusatzfunktion verfügbar.

otc_session_settings_set_proxy_url()
otc_status otc_session_settings_set_proxy_url ( otc_session_settings * Einstellungen,
const char * proxy_url
)

Legt die IP-Proxy-URL fest. Siehe die IP-Proxy-Entwicklerhandbuch.

otc_session_settings_set_session_migration()
otc_status otc_session_settings_set_session_migration ( otc_session_settings * Einstellungen,
otc_bool aktivieren
)

Aktiviert oder deaktiviert die Sitzungsmigration für eine Sitzung.

Aktiviert die Funktion zur Sitzungsmigration, sodass der Client während der Serverrotation verbunden bleibt. Der Standardwert lautet false (Die Sitzungsmigration ist nicht aktiviert). Weitere Informationen finden Sie unter Server-Rotation und Sitzungsmigration.

Parameter : | | | | --- | --- | | settings | Zeiger auf das Objekt mit den Sitzungseinstellungen. | | enable | Boolescher Flag zum Aktivieren (OTC_TRUE) oder Deaktivieren (OTC_FALSE) der Sitzungsmigration. |

Rückgabewerte : otc_status Gibt den Status der Operation zurück.

otc_session_settings_set_single_peer_connection()
otc_status otc_session_settings_set_single_peer_connection ( otc_session_settings * Einstellungen,
otc_bool aktivieren
)

Aktiviert oder deaktiviert die Single-Peer-Verbindung (SPC) für eine Sitzung.

Single Peer Connection (SPC) ist eine Funktion, die alle Teilnehmerverbindungen in einer einzigen Peer-Verbindung zusammenfasst. Zu den Vorteilen der Aktivierung von SPC zählen ein geringerer Ressourcenverbrauch des Betriebssystems, eine verbesserte Ratenkontrolle sowie – bei mobilen Geräten – die Unterstützung größerer Sitzungen.

SPC ist standardmäßig deaktiviert. Ist diese Funktion deaktiviert, nutzt die Sitzung die Multiple-Peer-Verbindung (MPC), bei der zwischen jedem Endpunkt eine separate Peer-Verbindung hergestellt wird.

Parameter : | | | | --- | --- | | settings | Zeiger auf das Objekt mit den Sitzungseinstellungen. | | enable | Boolescher Schalter zum Aktivieren (OTC_TRUE) oder Deaktivieren (OTC_FALSE) von SPC. |

Rückgabewerte : otc_status Gibt den Status der Operation zurück.

otc_session_subscribe()
otc_status otc_session_subscribe ( otc_session * Sitzung,
otc_Abonnent * Teilnehmer
)

Beginnt in dieser Sitzung mit dem Abonnieren (dem Empfang eines Streams) des Audio-Video-Streams eines Abonnenten.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert, die den Stream des Teilnehmers enthält. | | Teilnehmer | Der otc_subscriber Struktur, die den Abonnenten repräsentiert. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_unpublish()
otc_status otc_session_unpublish ( otc_session * Sitzung,
otc_publisher * Herausgeber
)

Löst einen Publisher aus einer Sitzung aus (wodurch dessen Stream gestoppt wird).

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert, deren Veröffentlichung rückgängig gemacht werden soll. | | publisher | Der otc_publisher Struktur, die den Herausgeber repräsentiert. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.

otc_session_unsubscribe()
otc_status otc_session_unsubscribe ( otc_session * Sitzung,
otc_Abonnent * Teilnehmer
)

Beendet das Abonnieren (den Empfang eines Streams) für einen bestimmten Abonnenten in der Sitzung.

Parameter : | | | | --- | --- | | session | Die otc_session Struktur, die die OpenTok-Sitzung repräsentiert, die den Stream des Teilnehmers enthält. | | Teilnehmer | Der otc_subscriber Struktur, die den Abonnenten repräsentiert. |

Rückgabewerte : Rückgabewert, der entweder einen Fehler oder einen Erfolg anzeigt.