#include <session.h>

Ausführliche Beschreibung

Callback-Funktionen für Sitzungen.

Diese Struktur enthält eine Reihe von Funktionszeigern auf Callback-Funktionen für Ereignisse im Zusammenhang mit einer OpenTok-Sitzung.

Alle Rückrufe erfolgen nicht über die Anwendung oder den Hauptthread, sondern über einen internen Thread. Die Anwendung sollte den Rückruf so schnell wie möglich zurückgeben, um ein Blockieren des internen Threads zu vermeiden.

Daten, die an eine Callback-Funktion übergeben werden (mit Ausnahme von session und user_data) wird nach dem Aufruf des Callbacks freigegeben. Erstellen Sie eine Kopie der Daten, falls Sie diese behalten möchten.

Felddokumentation

on_archive_started

Wird aufgerufen, wenn die Aufzeichnung eines Archivs der Sitzung beginnt. Siehe die Leitfaden für Entwickler zur Archivierung.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | archive_id | Die Archiv-ID. | | name | Der Name des Archivs (sofern bei der Erstellung des Archivs ein Name angegeben wurde). |

on_archive_stopped

Wird aufgerufen, wenn die Aufzeichnung eines Archivs der Sitzung beendet wird.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die von Ihnen für die Sitzung festgelegten Benutzerdaten. | | archive_id | Die Archiv-ID. |

on_connected

Wird aufgerufen, wenn die otc_session_connect Die Funktion verbindet den Client erfolgreich mit einer OpenTok-Sitzung.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die „user_data“, die Sie für die Sitzung festgelegt haben. |

on_connection_created

Wird aufgerufen, wenn eine neue Verbindung (von einem anderen Client) hergestellt wird.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die „user_data“, die Sie für die Sitzung festgelegt haben. | | connection | Die otc_connection Struktur, die dem Client entspricht, der eine Verbindung zur Sitzung herstellt. |

on_connection_dropped

Wird aufgerufen, wenn die Verbindung eines anderen Clients zur Sitzung unterbrochen wird.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die „user_data“, die Sie für die Sitzung festgelegt haben. | | connection | Die otc_connection Struktur, die dem Abmelden des Clients von der Sitzung entspricht. |

on_disconnected

Wird aufgerufen, wenn der Client nicht mehr mit der OpenTok-Sitzung verbunden ist.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die „user_data“, die Sie für die Sitzung festgelegt haben. |

on_error

Wird aufgerufen, wenn die Sitzung fehlschlägt.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die von Ihnen für die Sitzung festgelegten Benutzerdaten. | | error_string | Die Fehlermeldung. | | error | Der Fehlercode (vom Typ otc_session_error_code). |

on_mute_forced

Wird aufgerufen, wenn ein Moderator Streams in der Sitzung stummschaltet oder den Stummschaltstatus in der Sitzung aufhebt.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die „user_data“, die Sie für die Sitzung festgelegt haben. | | mute_info | Überprüfen Sie die active Eigenschaft dieser Struktur. Sie ist auf OTC_TRUE wenn ein Moderator den Ton in der Sitzung stummgeschaltet hat. Die Einstellung lautet OTC_FALSE wenn ein Moderator die Stummschaltung des Tons in der Sitzung aufhebt. |

on_reconnected

Wird aufgerufen, wenn der lokale Client die Verbindung zur OpenTok-Sitzung wiederhergestellt hat, nachdem die Netzwerkverbindung vorübergehend unterbrochen war.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die „user_data“, die Sie für die Sitzung festgelegt haben. |

on_reconnection_started

Wird aufgerufen, wenn der lokale Client die Verbindung zur OpenTok-Sitzung verloren hat und versucht, die Verbindung wiederherzustellen.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die „user_data“, die Sie für die Sitzung festgelegt haben. |

on_signal_received

Wird aufgerufen, wenn in der Sitzung ein Signal empfangen wird. Siehe die Überblick über die Signalisierung Dokumentation.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die „user_data“, die Sie für die Sitzung festgelegt haben. | | type | Die Typzeichenfolge für das Signal (sofern beim Senden des Signals eine angegeben wurde). | | signal | Die Datenzeichenfolge für das Signal (sofern beim Senden des Signals eine angegeben wurde). | | connection | Die otc_connection der den Client repräsentiert, der das Signal gesendet hat. |

on_stream_dropped

Wird aufgerufen, wenn der Stream eines anderen Clients aus dieser OpenTok-Sitzung entfernt wird.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die von Ihnen für die Sitzung festgelegten Benutzerdaten. | | stream | Der otc_stream Struktur, die den Stream darstellt. |

on_stream_has_audio_changed

Wird aufgerufen, wenn ein Stream den Ton ein- oder ausschaltet.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die von Ihnen für die Sitzung festgelegten Benutzerdaten. | | stream | Der otc_stream Struktur, die den neuen Stream darstellt. | | has_audio | Gibt an, ob der Stream nun Audio enthält (OTC_TRUE) oder nicht (OTC_FALSE). |

on_stream_has_captions_changed

Wird aufgerufen, wenn in einem Stream die Untertitel ein- oder ausgeschaltet werden.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die „user_data“, die Sie für die Sitzung festgelegt haben. | | stream | Ein Zeiger auf die Struktur „otc_stream“, die den Stream repräsentiert. | | has_captions | Gibt an, ob der Stream derzeit Untertitel enthält (OTC_TRUE) oder nicht (OTC_FALSE). |

on_stream_has_video_changed

Wird aufgerufen, wenn ein Stream die Videoübertragung ein- oder ausschaltet.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die „user_data“, die Sie für die Sitzung festgelegt haben. | | stream | Gibt an, ob der Stream derzeit Videodaten enthält (OTC_TRUE) oder nicht (OTC_FALSE). |

on_stream_received

Wird aufgerufen, wenn in dieser OpenTok-Sitzung ein neuer Stream vorliegt. Rufen Sie die otc_session_subscribe Funktion zum Abonnieren des Streams.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die von Ihnen für die Sitzung festgelegten Benutzerdaten. | | stream | Der otc_stream Struktur, die den neuen Stream darstellt. |

on_stream_video_dimensions_changed

Wird aufgerufen, wenn sich die Videoabmessungen eines Streams in der Sitzung ändern.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die „user_data“, die Sie für die Sitzung festgelegt haben. | | width | Die neue Breite des Streams in Pixeln. | | height | Die neue Höhe des Streams in Pixeln. |

on_stream_video_type_changed

Wird aufgerufen, wenn sich der Videotyp eines Streams in der Sitzung ändert.

Parameter : | | | | --- | --- | | session | Ein Zeiger auf die Struktur „otc_session“. | | user_data | Ein Zeiger auf die von Ihnen für die Sitzung festgelegten Benutzerdaten. | | type | Der neue Stream-Typ. |

reserviert

Ein void-Zeiger auf einen Speicherbereich, der reservierte Ressourcen enthält, die für die interne Implementierung verwendet werden.

user_data

Ein Zeiger auf die von Ihnen festgelegten Daten, die sich auf die Sitzung beziehen.