OpenTok-Abonnent. Mehr...

#include "audio_data.h" #include "base.h" #include "config.h" #include "error.h" #include "media_utils.h" #include "stream.h" #include "video_frame.h"
Typdefinitionen
typedef struct otc_Abonnent otc_Abonnent
Funktionen
otc_Abonnent * otc_subscriber_new (const otc_stream *stream, const struct otc_subscriber_callbacks *Callbacks)
otc_status otc_subscriber_delete (otc_Abonnent *Abonnent)
otc_stream * otc_subscriber_get_stream (const otc_Abonnent *Abonnent)
otc_status otc_subscriber_set_subscribe_to_video (otc_Abonnent *Abonnent, otc_bool (subscribe_to_video)
otc_status otc_subscriber_set_subscribe_to_audio (otc_Abonnent *Abonnent, otc_bool (subscribe_to_audio)
otc_status otc_subscriber_set_subscribe_to_captions (otc_Abonnent *Abonnent, otc_bool (subscribe_to_captions)
otc_status otc_subscriber_set_captions_translation_language (otc_Abonnent *subscriber, const char *language)
otc_bool otc_subscriber_get_subscribe_to_video (const otc_Abonnent *Abonnent)
otc_bool otc_subscriber_get_subscribe_to_audio (const otc_Abonnent *Abonnent)
otc_bool otc_subscriber_get_subscribe_to_captions (const otc_Abonnent *Abonnent)
otc_session * otc_subscriber_get_session (const otc_Abonnent *Abonnent)
otc_status otc_subscriber_set_preferred_resolution (otc_Abonnent *subscriber, uint32_t preferred_width, uint32_t preferred_height)
otc_status otc_subscriber_get_preferred_resolution (const otc_Abonnent *subscriber, uint32_t *preferred_width, uint32_t *preferred_height)
otc_status otc_subscriber_set_audio_volume (otc_Abonnent *Abonnent, doppelte Ausgabe)
otc_status otc_subscriber_get_audio_volume (const otc_Abonnent *Abonnent, doppelte *Auflage)
otc_status otc_subscriber_set_preferred_framerate (otc_Abonnent *subscriber, float preferred_framerate)
otc_status otc_subscriber_get_preferred_framerate (const otc_Abonnent *subscriber, float *preferred_framerate)
const char * otc_subscriber_get_subscriber_id (const otc_Abonnent *Abonnent)
void * otc_subscriber_get_user_data (const otc_Abonnent *Abonnent)
otc_status otc_subscriber_get_rtc_stats_report (const otc_Abonnent *Abonnent)
otc_status otc_subscriber_set_rtc_stats_report_cb (otc_Abonnent *Abonnent, Struktur otc_subscriber_rtc_stats_report_cb cb)
const char * otc_subscriber_get_captions_translation_language (const otc_Abonnent *Abonnent)

Ausführliche Beschreibung

OpenTok-Abonnent.

Diese Datei enthält die Typdefinition für einen OpenTok-Abonnenten sowie mehrere Funktionsdeklarationen.

Typedef-Dokumentation

otc_Abonnent
typedef struct otc_Abonnent otc_Abonnent

Definition des OpenTok-Abonnententyps.

Ein Typ, der den Empfänger von Audio- und Videodaten aus einem Stream in der OpenTok-Sitzung repräsentiert.

Dokumentation zu Aufzählungstypen

otc_subscriber_error_code

Auflistung der Fehlercodes für OpenTok-Teilnehmer. Diese Auflistung enthält verschiedene Fehlercodes, die mit einem Teilnehmer in Verbindung stehen.

Zähler
OTC_SUBSCRIBER_INTERNAL_ERROR Interner Fehler beim Abonnieren.
OTC_SUBSCRIBER_SESSION_DISCONNECTED Es wird versucht, einen Stream in einer Sitzung zu abonnieren, von der die Verbindung bereits getrennt wurde.
OTC_SUBSCRIBER_SERVER_CANNOT_FIND_STREAM Der Abonnent ist fehlgeschlagen, da der Stream fehlt. Dies kann passieren, wenn der Abonnent genau zu dem Zeitpunkt angelegt wird, zu dem der Stream aus der Sitzung entfernt wird.
OTC_SUBSCRIBER_STREAM_LIMIT_EXCEEDED Der Client hat versucht, einen Stream in einer Sitzung zu abonnieren, bei der das Limit für gleichzeitige Streams überschritten wurde.
OTC_SUBSCRIBER_TIMED_OUT Zeitüberschreitung beim Versuch, ein Abonnement abzuschließen.
OTC_SUBSCRIBER_WEBRTC_ERROR WebRTC-Fehler beim Teilnehmer.
OTC_SUBSCRIBER_PEER_CONNECTION_NOT_CONNECTED Die Peer-Verbindung wurde noch nicht hergestellt oder ist noch nicht verbunden.
OTC_SUBSCRIBER_DECRYPTION_INTERNAL_ERROR Interner Fehler beim Entschlüsseln eines Pakets
OTC_SUBSCRIBER_ENCRYPTION_SECRET_MISMATCH Heimlicher Abgleichfehler beim Entschlüsseln eines Pakets
OTC_SUBSCRIBER_DECRYPTION_UNSUPPORTED_CODEC Nicht unterstützter Medien-Codec für die Entschlüsselung

Funktionsdokumentation

otc_subscriber_delete()
otc_status otc_subscriber_delete ( otc_Abonnent * Teilnehmer )

Gibt eine Subscriber-Instanz frei, einschließlich aller damit verknüpften Hardware- und UI-Ressourcen. Keine Callbacks in otc_subscriber_callbacks wird infolge des Aufrufs dieser Methode (oder danach) aufgerufen.

Parameter : | | | | --- | --- | | Teilnehmer | Der zu löschende Teilnehmer. |

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

otc_subscriber_get_audio_volume()
otc_status otc_subscriber_get_audio_volume ( const otc_Abonnent * Teilnehmer,
doppelt * Umfang
)

Gibt die Lautstärke des Teilnehmers als Wert zwischen 0 und 100 zurück.

Der Standardwert beträgt 100.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz. | | volume | Das Volume des Subscribers. |

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

Siehe auch : otc_Fehlercode

otc_subscriber_get_captions_translation_language()
const char * otc_subscriber_get_captions_translation_language ( const otc_Abonnent * Teilnehmer )

Ruft die konfigurierte Sprache für die Übersetzung der Bildunterschriften für einen bestimmten Abonnenten ab.

Dies ist eine Funktion der privaten Beta-Version.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz. |

Rückgabewert : Die für die Übersetzung konfigurierte Sprache. Der Wert kann null sein, wenn keine Sprache festgelegt wurde.

otc_subscriber_get_preferred_framerate()
otc_status otc_subscriber_get_preferred_framerate ( const otc_Abonnent * Teilnehmer,
float * bevorzugte_framerate
)

Gibt die bevorzugte Bildrate für den Stream des Abonnenten zurück.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz. | | preferred_framerate | Die dem Subscriber zugeordnete bevorzugte Bildrate. |

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

Siehe auch : otc_Fehlercode

otc_subscriber_get_preferred_resolution()
otc_status otc_subscriber_get_preferred_resolution ( const otc_Abonnent * Teilnehmer,
uint32_t * bevorzugte_Breite,
uint32_t * bevorzugte_Höhe
)

Gibt die bevorzugte Auflösung für den Stream des Abonnenten zurück.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz. | | preferred_width | Die bevorzugte Breite des Subscribers. | | preferred_height | Die bevorzugte Höhe des Subscribers. |

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

Siehe auch : otc_Fehlercode

otc_subscriber_get_rtc_stats_report()
otc_status otc_subscriber_get_rtc_stats_report ( const otc_Abonnent * Teilnehmer )

Ruft den RTC-Statistikbericht für den Teilnehmer ab. Dies ist ein asynchroner Vorgang. Erstellen Sie einen otc_subscriber_rtc_stats_report_cb Struktur und übergeben Sie sie an die otc_subscriber_set_rtc_stats_report_cb Funktion vor dem Aufruf dieser Funktion. Sobald die Statistiken verfügbar sind, wird die otc_subscriber_set_rtc_stats_report_cb Callback-Funktion aufgerufen wird.

Siehe auch otc_subscriber_callbacks.on_audio_stats, otc_subscriber_callbacks.on_video_statsund otc_publisher_get_rtc_stats_report.

Parameter : | | | | --- | --- | | Teilnehmer | Der Teilnehmer. |

otc_subscriber_get_session()
otc_session * otc_subscriber_get_session ( const otc_Abonnent * Teilnehmer )

Gibt die otc_session dieser Instanz zugeordnet.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz. |

Rücksendungen : Die otc_session dieser Instanz zugeordnet. Im Fehlerfall kann dieser Wert null sein.

otc_subscriber_get_stream()
otc_stream * otc_subscriber_get_stream ( const otc_Abonnent * Teilnehmer )

Gibt den mit dem Abonnenten verknüpften Stream zurück.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz, von der der Stream abgerufen werden soll. |

Rückgabewerte : Der mit dem Abonnenten verknüpfte Stream. Dieser kann bei einem Fehler null sein.

otc_subscriber_get_subscribe_to_audio()
otc_bool otc_subscriber_get_subscribe_to_audio ( const otc_Abonnent * Teilnehmer )

Gibt zurück, ob der Abonnent den Audio-Stream abonniert hat oder nicht.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz. |

Rückgabewert : Gibt an, ob der Abonnent den Audio-Stream abonniert hat oder nicht.

otc_subscriber_get_subscribe_to_captions()
otc_bool otc_subscriber_get_subscribe_to_captions ( const otc_Abonnent * Teilnehmer )

Gibt zurück, ob der Abonnent die Untertitel des Streams abonniert hat oder nicht.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz. |

Rückgabewert : Gibt an, ob der Abonnent die Untertitel des Streams abonniert hat oder nicht. Der Standardwert entspricht dem Wert für die Untertitel des Stream-Anbieters. otc_publisher_get_publish_captions

otc_subscriber_get_subscribe_to_video()
otc_bool otc_subscriber_get_subscribe_to_video ( const otc_Abonnent * Teilnehmer )

Gibt zurück, ob der Abonnent den Videostream abonniert hat oder nicht.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz. |

Rückgabewert : Gibt an, ob der Abonnent den Videostream abonniert hat oder nicht.

otc_subscriber_get_subscriber_id()
const char * otc_subscriber_get_subscriber_id ( const otc_Abonnent * Teilnehmer )

Ruft eine eindeutige Kennung für einen bestimmten Teilnehmer ab.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz. |

Rückgabewerte : Eine eindeutige Kennung für den Abonnenten. Diese kann bei einem Fehler den Wert „null“ annehmen.

otc_subscriber_get_user_data()
void * otc_subscriber_get_user_data ( const otc_Abonnent * Teilnehmer )

Ruft die Benutzerdaten eines bestimmten Teilnehmers ab.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz. |

Rückgabewerte : Ein Zeiger auf die Benutzerdaten im Speicher.

otc_subscriber_new()
otc_Abonnent * otc_subscriber_new ( const otc_stream * Strom,
const struct otc_subscriber_callbacks * Rückrufe
)

Erstellt einen neuen Abonnenten für einen bestimmten Stream.

Parameter : | | | | --- | --- | | stream | Das Stream-Objekt, das dem Stream entspricht, den Sie abonnieren möchten. | | callbacks | Struktur mit Funktionszeigern auf die Callbacks des Abonnenten. |

Rückgabewert : Die neue „Subscriber“-Instanz. Bei einem Fehler kann dieser Wert null sein.

otc_subscriber_set_audio_volume()
otc_status otc_subscriber_set_audio_volume ( otc_Abonnent * Teilnehmer,
doppelt Umfang
)

Stellt die Lautstärke des Teilnehmers auf einen Wert zwischen 0 und 100 ein. Liegt der Wert außerhalb dieses Bereichs, wird er auf einen Wert innerhalb dieses Bereichs begrenzt.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz. | | volume | Das Volume des Subscribers. |

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

Siehe auch : otc_Fehlercode

otc_subscriber_set_captions_translation_language()
otc_status otc_subscriber_set_captions_translation_language ( otc_Abonnent * Teilnehmer,
const char * Sprache
)

Legt die bevorzugte Sprache für die Übersetzung von Untertiteln für einen bestimmten Abonnenten fest.

Dies ist eine Funktion der privaten Beta-Version.

Parameter : | | | | --- | --- | | subscriber | Die betroffene Abonnenteninstanz. | | language | Ein unterstützter Sprachcode oder „null“, um die Übersetzung zu deaktivieren. |

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

otc_subscriber_set_preferred_framerate()
otc_status otc_subscriber_set_preferred_framerate ( otc_Abonnent * Teilnehmer,
float bevorzugte_framerate
)

Legt die bevorzugte Bildrate für den Stream des Teilnehmers fest.

Der Standardwert beträgt 100.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz, die davon betroffen ist. | | preferred_framerate | Die bevorzugte Bildrate des Subscribers. |

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

Siehe auch : otc_Fehlercode

otc_subscriber_set_preferred_resolution()
otc_status otc_subscriber_set_preferred_resolution ( otc_Abonnent * Teilnehmer,
uint32_t bevorzugte_Breite,
uint32_t bevorzugte_Höhe
)

Legt die bevorzugte Auflösung für den Stream des Abonnenten fest.

Parameter : | | | | --- | --- | | subscriber | Die betroffene Subscriber-Instanz. | | preferred_width | Die bevorzugte Breite des Subscribers. | | preferred_height | Die bevorzugte Höhe des Subscribers. |

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

Siehe auch : otc_Fehlercode

otc_subscriber_set_rtc_stats_report_cb()
otc_status otc_subscriber_set_rtc_stats_report_cb ( otc_Abonnent * Teilnehmer,
struct otc_subscriber_rtc_stats_report_cb cb
)

Legt den Callback für den RTC-Statistikbericht des Abonnenten fest. Siehe otc_subscriber_get_rtc_stats_report.

Parameter : | | | | --- | --- | | subscriber | Die Subscriber-Instanz. | | cb | Die otc_subscriber_rtc_stats_report_cb Struktur, die die Callback-Funktion für den RTC-Statistikbericht enthält. |

otc_subscriber_set_subscribe_to_audio()
otc_status otc_subscriber_set_subscribe_to_audio ( otc_Abonnent * Teilnehmer,
otc_bool subscribe_to_audio
)

Abonniert den Audio-Stream.

Parameter : | | | | --- | --- | | subscriber | Die betroffene Subscriber-Instanz. | | subscribe_to_audio | Gibt an, ob Audio abonniert werden soll oder nicht. |

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

otc_subscriber_set_subscribe_to_captions()
otc_status otc_subscriber_set_subscribe_to_captions ( otc_Abonnent * Teilnehmer,
otc_bool Untertitel abonnieren
)

Abonniert die Untertitel für den Stream.

Parameter : | | | | --- | --- | | subscriber | Die betroffene Abonnenteninstanz. | | subscribe_to_captions | Gibt an, ob Untertitel abonniert werden sollen oder nicht. |

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

otc_subscriber_set_subscribe_to_video()
otc_status otc_subscriber_set_subscribe_to_video ( otc_Abonnent * Teilnehmer,
otc_bool subscribe_to_video
)

Abonniert die Videos des Kanals.

Parameter : | | | | --- | --- | | subscriber | Die betroffene Abonnenteninstanz. | | subscribe_to_video | Gibt an, ob das Video abonniert werden soll oder nicht. |

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