Grundfunktionen. Mehr...

#include "config.h"
Datenstrukturen
struct otc_on_mute_forced_info
struct otc_transport_stats
Typdefinitionen
typedef int otc_bool
typedef int otc_status
typedef void(* otc_logger_callback) (const char *message)
Aufzählungen
enum otc_video_reason {   OTC_VIDEO_REASON_NONE = 0 , OTC_VIDEO_REASON_PUBLISH_VIDEO = 1 , OTC_VIDEO_REASON_SUBSCRIBE_TO_VIDEO = 2 , OTC_VIDEO_REASON_QUALITY = 3 ,   OTC_VIDEO_REASON_CODEC_NOT_SUPPORTED = 4 , OTC_VIDEO_REASON_QUALITY_DEGRADATION_BANDWIDTH = 5 , OTC_VIDEO_REASON_QUALITY_DEGRADATION_CPU , OTC_VIDEO_REASON_QUALITY_DEGRADATION_OTHER = 7 ,   OTC_VIDEO_REASON_CODEC_CHANGE = 8 , OTC_VIDEO_REASON_RESOLUTION_CHANGE = 9 , OTC_VIDEO_REASON_VIDEO_INTERRUPTION = 10 , OTC_VIDEO_REASON_SENDER_QUALITY_RESTRICTION = 11 }
enum otc_network_reason {   OTC_NETWORK_REASON_NONE = 0 , OTC_NETWORK_REASON_UNKNOWN = 1 , OTC_NETWORK_REASON_BANDWIDTH = 2 , OTC_NETWORK_REASON_PACKET_LOSS = 3 ,   OTC_NETWORK_REASON_NETWORK_CONDITION_CHANGE = 4 }
enum otc_constant { OTC_SUCCESS = 0 , OTC_FALSE = 0 , OTC_TRUE = !OTC_FALSE }
enum otc_Fehlercode {   OTC_INVALID_PARAM = 1 , OTC_FATAL = 2 , OTC_INVALID_VIDEO_FORMAT = 3 , OTC_CONNECTION_DROPPED = 1022 ,   OTC_UNABLE_TO_FORCE_DISCONNECT = 1520 , OTC_UNABLE_TO_FORCE_MUTE = 1540 , OTC_CONNECTION_TIMED_OUT = 1542 , OTC_UNKNOWN_PUBLISHER_INSTANCE = 2003,   OTC_UNKNOWN_SUBSCRIBER_INSTANCE = 2004, OTC_VIDEO_CAPTURE_FAILED = 3000 , OTC_CAMERA_FAILED = 3010 , OTC_VIDEO_RENDER_FAILED = 4000 ,   OT_UNABLE_TO_ACCESS_MEDIA_ENGINE = 5000 }
enum otc_log_level {   OTC_LOG_LEVEL_DISABLED = 0 , OTC_LOG_LEVEL_ERROR = 1 , OTC_LOG_LEVEL_WARN = 2 , OTC_LOG_LEVEL_INFO = 3 ,   OTC_LOG_LEVEL_DEBUG = 4 , OTC_LOG_LEVEL_TRACE = 5 , OTC_LOG_LEVEL_FATAL = OTC_LOG_LEVEL_ERROR , OTC_LOG_LEVEL_MSG = OTC_LOG_LEVEL_DEBUG ,   OTC_LOG_LEVEL_ALL = OTC_LOG_LEVEL_TRACE }
enum otc_network_condition {   OTC_NETWORK_CONDITION_UNKNOWN = 0 , OTC_NETWORK_CONDITION_CRITICAL = 1 , OTC_NETWORK_CONDITION_WARNING = 2 , OTC_NETWORK_CONDITION_FAIR = 3 ,   OTC_NETWORK_CONDITION_GOOD = 4 , OTC_NETWORK_CONDITION_EXCELLENT = 5 }
Geschätzter Netzwerkzustandswert für einen Transport. Mehr...
enum otc_network_degradation_source { OTC_NETWORK_DEGRADATION_SOURCE_NONE = 0 , OTC_NETWORK_DEGRADATION_SOURCE_BOTH_OR_UNCLEAR , OTC_NETWORK_DEGRADATION_SOURCE_LOCAL , OTC_NETWORK_DEGRADATION_SOURCE_REMOTE }

Ausführliche Beschreibung

Grundfunktionen.

Diese Datei enthält Funktionen zur Initialisierung und Beendigung der Bibliotheks-Engine sowie weitere Funktionen zur Aktivierung der Konsolenprotokollierung.

Typedef-Dokumentation

otc_bool
typedef int otc_bool

Typdefinition für boolesche Werte.

Nützlicher Typ für Variablen zur Darstellung von Booleschen Werten (wahr und falsch).

otc_logger_callback
typedef void(* otc_logger_callback) (const char *message)

Typdefinition für einen Funktionszeiger auf die Funktion, die als benutzerdefinierter Protokollierungs-Callback verwendet wird, um vom SDK protokollierte Meldungen abzurufen.

Parameter : | | | | --- | --- | | Nachricht | Ein Zeiger auf die zu protokollierende Nachricht. |

Siehe auch : otc_log_set_logger_callback

otc_status
typedef int otc_status

Typdefinition für Status.

Dies ist der häufigste Rückgabetyp für Funktionen in dieser Bibliothek. Dieser Typ umfasst Werte aus den Fehlercode-Aufzählungen.

Siehe auch : otc_constant : otc_Fehlercode : otc_session_error_code : otc_publisher_error_code : otc_subscriber_error_code

Dokumentation zu Aufzählungstypen

otc_constant

Diese Aufzählung enthält häufig verwendete Konstanten.

Zähler
OTC_SUCCESS Eine Konstante, die für Erfolg steht.
OTC_FALSE Konstante, die den Wert „false“ darstellt.
OTC_TRUE Konstante, die den Wert „wahr“ darstellt.

otc_Fehlercode

Diese Aufzählung umfasst auch Fehlercodes.

Zähler
OTC_INVALID_PARAM Fehlercode wegen ungültigem Funktionsargument. Ein bei einem Funktionsaufruf verwendetes Argument ist ungültig.
OTC_FATAL Schwerwiegender Fehlercode. Allgemeiner Fehler.
OTC_INVALID_VIDEO_FORMAT Ungültiges Videoformat Wird ausgelöst, wenn der Aufzeichner mit einem ungültigen Videoformat konfiguriert ist
OTC_CONNECTION_DROPPED Fehlercode „Verbindung unterbrochen“. Die Verbindung zum OpenTok-Messaging-Server wurde unterbrochen. Überprüfen Sie die Netzwerkverbindung.
OTC_UNABLE_TO_FORCE_DISCONNECT Fehlercode bei erzwungener Trennung. Aufruf konnte nicht erfolgreich durchgeführt werden otc_session_force_disconnect, möglicherweise aufgrund fehlender Berechtigungen.
OTC_UNABLE_TO_FORCE_MUTE Fehlercode „Stummschaltung erzwingen“. Der Aufruf konnte nicht erfolgreich ausgeführt werden. otc_session_force_mute_all oder otc_session_force_mute_stream, möglicherweise aufgrund fehlender Berechtigungen.
OTC_CONNECTION_TIMED_OUT Fehlercode wegen Zeitüberschreitung bei der Verbindung. Zeitüberschreitung während des Verbindungsaufbaus.
OTC_UNKNOWN_PUBLISHER_INSTANCE Fehlercode einer unbekannten Publisher-Instanz. Eine unbekannte Publisher-Instanz wurde als Funktionsargument verwendet.
OTC_UNKNOWN_SUBSCRIBER_INSTANCE Fehlercode für unbekannte Abonnenteninstanz. Eine unbekannte Abonnenteninstanz wurde als Funktionsargument verwendet.
OTC_VIDEO_CAPTURE_FAILED Fehlercode bei der Videoaufnahme. Es ist ein Fehler beim Videoaufnahmegerät aufgetreten.
OTC_CAMERA_FAILED Fehler beim Abrufen der Videodaten von der Kamera. Beim Abrufen der Videodaten von der Kamera ist ein Fehler aufgetreten.
OTC_VIDEO_RENDER_FAILED Fehlercode beim Rendern des Videos. Beim Rendern des Videos ist ein Fehler aufgetreten.
OT_UNABLE_TO_ACCESS_MEDIA_ENGINE Fehlercode beim Zugriff auf die Medien-Engine. Beim Abrufen der Liste der unterstützten Videocodecs ist ein Fehler aufgetreten.

otc_log_level

Aufzählung der Protokollstufen.

Diese Aufzählung zeigt die verschiedenen unterstützten Protokollstufen auf.

Zähler
OTC_LOG_LEVEL_DISABLED Aufzählungswert „Keine Meldungen“.
OTC_LOG_LEVEL_ERROR Fehlermeldungen.
OTC_LOG_LEVEL_WARN Meldungen der Warnstufe.
OTC_LOG_LEVEL_INFO Meldungen der Info-Ebene.
OTC_LOG_LEVEL_DEBUG Meldungen auf Debug-Ebene.
OTC_LOG_LEVEL_TRACE Meldungen auf Trace-Ebene (höchste Ausführlichkeit).
OTC_LOG_LEVEL_FATAL VERALTET.
OTC_LOG_LEVEL_MSG VERALTET.
OTC_LOG_LEVEL_ALL VERALTET.

otc_network_condition

Geschätzter Netzwerkzustandswert für einen Transport.

Diese Enumeration gibt den Gesamtzustand der Netzwerkverbindung für einen bestimmten Transport (lokal oder remote) wieder. Sie wird in der Regel aus Kennzahlen wie Paketverlust und der geschätzten verfügbaren Bandbreite abgeleitet. Höhere Werte weisen auf bessere Netzwerkbedingungen hin.

OTC_NETWORK_CONDITION_WARNING und OTC_NETWORK_CONDITION_CRITICAL weisen auf verschlechterte Netzwerkbedingungen hin, die Callbacks für den Audio-Fallback auslösen können. Ist der Audio-Fallback aktiviert, benachrichtigt das SDK über die entsprechenden Callbacks; im Zustand „CRITICAL“ wird die Videoübertragung deaktiviert, um die Stabilität des Anrufs zu gewährleisten.

Zähler
OTC_NETWORK_CONDITION_UNKNOWN Der Netzwerkstatus konnte nicht ermittelt werden
OTC_NETWORK_CONDITION_CRITICAL Schwerwiegende Netzwerkprobleme; Audio-Fallback wird ausgelöst, sofern aktiviert
OTC_NETWORK_CONDITION_WARNING Schlechte Netzwerkbedingungen; die Videoqualität ist stark beeinträchtigt, und es kann eine Warnmeldung zur Deaktivierung des Videos angezeigt werden, wenn der Audio-Fallback aktiviert ist
OTC_NETWORK_CONDITION_FAIR Netzwerkbedingungen sind mäßig; die Videoqualität kann durch den Medienserver oder den Peer eingeschränkt sein
OTC_NETWORK_CONDITION_GOOD Gute Netzwerkbedingungen; es können vorübergehend kleinere Störungen auftreten
OTC_NETWORK_CONDITION_EXCELLENT Hervorragende Netzwerkbedingungen; die Videoqualität ist optimal und die geschätzte Bandbreite reicht für die maximale Bitrate bei der aktuellen Auflösung aus

otc_network_degradation_source

Zeigt die Ursache für die Beeinträchtigung der Video- oder Netzwerkqualität in der Sitzung an.

Diese Aufzählung gibt an, welche Seite des Anrufs für festgestellte Netzwerkprobleme verantwortlich ist, die sich auf die Videoqualität auswirken. Sie ergänzt die Metriken zum Netzwerkzustand der einzelnen Übertragungsprotokolle.

Zähler
OTC_NETWORK_DEGRADATION_SOURCE_NONE Es wurde keine Verschlechterung festgestellt; die Videoqualität ist gut.
OTC_NETWORK_DEGRADATION_SOURCE_BOTH_OR_UNCLEAR Es wurde eine Verschlechterung festgestellt, die dafür verantwortliche Seite kann jedoch nicht ermittelt werden.
OTC_NETWORK_DEGRADATION_SOURCE_LOCAL Die Ursache für die Leistungsminderung liegt im lokalen Netzwerk oder im Transportnetz.
OTC_NETWORK_DEGRADATION_SOURCE_REMOTE Ein Problem im Remote-Netzwerk oder beim Transport ist die Ursache für die Leistungsminderung.

otc_network_reason

Enum zur Beschreibung von Ursachen, die sich auf den Netzwerkzustand auswirken.

Diese Werte geben Aufschluss über die wichtigsten Faktoren, die die aktuelle Bewertung des Netzwerkzustands beeinflussen, wie beispielsweise Bandbreitenengpässe oder Paketverluste.

Zähler
OTC_NETWORK_REASON_NONE Kein nennenswerter Grund.
OTC_NETWORK_REASON_UNKNOWN Ursache unbekannt.
OTC_NETWORK_REASON_BANDWIDTH Die Bewertung des Netzwerkzustands wird durch die Bandbreite beeinflusst.
OTC_NETWORK_REASON_PACKET_LOSS Der Netzwerkzustandswert wird durch Paketverluste beeinflusst.
OTC_NETWORK_REASON_NETWORK_CONDITION_CHANGE Zeigt an, dass sich der Netzwerkstatus des lokalen oder entfernten Teilnehmers geändert hat. Wird ausgelöst, wenn eine wesentliche Änderung im Netzwerk des lokalen oder entfernten Teilnehmers festgestellt wird.

otc_video_reason

Enum für Gründe, aus denen ein Video gestartet, angehalten, fortgesetzt usw. wird.

Zähler
OTC_VIDEO_REASON_NONE Keine Qualitätsminderung oder nennenswerte Videoveränderung. Standardmäßiger oder unbekannter Grund.
OTC_VIDEO_REASON_PUBLISH_VIDEO Der Client, der den Stream veröffentlicht hat, hat die Videoübertragung eingestellt.
OTC_VIDEO_REASON_SUBSCRIBE_TO_VIDEO Der lokale Kunde hat sein Video-Abonnement gekündigt.
OTC_VIDEO_REASON_QUALITY Das Problem mit dem Video wurde durch eine Änderung der Qualität des Videostreams verursacht.
OTC_VIDEO_REASON_CODEC_NOT_SUPPORTED Der Videofehler trat auf, weil das Video im Abonnentenstrom deaktiviert wurde, da der Stream einen Videocodec verwendet, der auf dem Gerät nicht unterstützt wird.
OTC_VIDEO_REASON_QUALITY_DEGRADATION_BANDWIDTH Qualitätsverlust aufgrund unzureichender Netzwerkbandbreite.
OTC_VIDEO_REASON_QUALITY_DEGRADATION_CPU Qualitätsverlust aufgrund von CPU-Einschränkungen auf dem Client-Gerät.
OTC_VIDEO_REASON_QUALITY_DEGRADATION_OTHER Qualitätsminderung aus anderen Gründen
OTC_VIDEO_REASON_CODEC_CHANGE Der Videocodec hat sich geändert
OTC_VIDEO_REASON_RESOLUTION_CHANGE Änderung der Videoauflösung oder der Anzahl der Ebenen Dies kann aufgrund von Bitratenbeschränkungen, einer Anpassung des Encoders, Änderungen an der Kameraquelle (z. B. Kamerawechsel oder Änderung der Eingangsauflösung) oder Konfigurationsänderungen auftreten und bedeutet nicht immer eine Verschlechterung der Qualität.
OTC_VIDEO_REASON_VIDEO_INTERRUPTION Ereignis: Unterbrechung der Videoübertragung
OTC_VIDEO_REASON_SENDER_QUALITY_RESTRICTION Vom Absender begrenzte Videoqualität

Funktionsdokumentation

otc_destroy()
otc_status otc_destroy ( )

Löst die Bibliotheks-Engine auf. Sie sollten diese Funktion aufrufen, wenn Sie die Ausführung des Codes, der die Bibliothek nutzt, abgeschlossen haben.

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

otc_get_log_level()
enum otc_log_level otc_get_log_level ( )

Ruft die aktuelle Protokollierungsstufe der Konsole ab.

Rückgabewerte : Die festgelegte Protokollstufe.

otc_init()
otc_status otc_init ( void * reserviert )

Initialisiert die Bibliothek. Sie müssen diese Funktion aufrufen, bevor Sie anderen Code ausführen, der die Bibliothek nutzt.

Parameter : | | | | --- | --- | | reserved | Ein `void`-Zeiger auf einen Speicherbereich, der reservierte Ressourcen enthält, die für die interne Implementierung verwendet werden. Dieser muss auf NULL. |

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

otc_log_enable()
void otc_log_enable ( enum otc_log_level log_level )

Aktiviert die Protokollierung von SDK-Meldungen für eine bestimmte Protokollierungsstufe.

Parameter : | | | | --- | --- | | log_level | Die gewünschte Protokollierungsstufe. |

Siehe auch : otc_log_set_logger_callback : otc_get_log_level

otc_log_set_logger_callback()
void otc_log_set_logger_callback ( otc_logger_callback Rückruf )

Legt den Funktionszeiger auf eine benutzerdefinierte Protokollierungs-Callback-Funktion fest, um vom SDK protokollierte Meldungen abzurufen. Wenn Sie keine Protokollierungs-Callback-Funktion festlegen, protokolliert das SDK die Meldungen in der Konsole.

Parameter : | | | | --- | --- | | callback | Ein Zeiger auf die Callback-Funktion. |

Siehe auch : otc_log_enable