Grundfunktionen. Mehr...

#include "config.h"
Datenstrukturen
struct otc_on_mute_forced_info
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_PUBLISH_VIDEO , OTC_VIDEO_REASON_SUBSCRIBE_TO_VIDEO , OTC_VIDEO_REASON_QUALITY = 3 , OTC_VIDEO_REASON_CODEC_NOT_SUPPORTED = 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_FATAL = OTC_LOG_LEVEL_ERROR , OTC_LOG_LEVEL_MSG = OTC_LOG_LEVEL_DEBUG , OTC_LOG_LEVEL_TRACE = OTC_LOG_LEVEL_DEBUG ,   OTC_LOG_LEVEL_ALL = OTC_LOG_LEVEL_DEBUG }

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_FATAL VERALTET.
OTC_LOG_LEVEL_MSG VERALTET.
OTC_LOG_LEVEL_TRACE VERALTET.
OTC_LOG_LEVEL_ALL VERALTET.

otc_video_reason

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

Zähler
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.

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