OpenTok Publisher. Mehr...

#include "config.h" #include "stream.h" #include "video_frame.h" #include "audio_data.h" #include "camera_capture_resolution.h" #include "media_transformer.h" #include "video_capturer.h"

Typdefinitionen
typedef struct otc_publisher otc_publisher
typedef struct otc_publisher_settings otc_publisher_settings
Funktionen
otc_publisher * otc_publisher_new (const char *name, const struct otc_video_capturer_callbacks *capturer, const struct otc_publisher_callbacks *Callbacks)
otc_publisher_settings * otc_publisher_settings_new ()
otc_status otc_publisher_settings_delete (otc_publisher_settings *Einstellungen)
otc_status otc_publisher_settings_set_name (otc_publisher_settings *Einstellungen, const char *name)
otc_status otc_publisher_settings_set_video_capturer (otc_publisher_settings *Einstellungen, const struct otc_video_capturer_callbacks *Aufnehmer)
otc_status otc_publisher_settings_set_audio_track (otc_publisher_settings *Einstellungen, otc_bool (aktiviert)
otc_status otc_publisher_settings_set_video_track (otc_publisher_settings *Einstellungen, otc_bool (aktiviert)
otc_status otc_publisher_settings_set_stereo (otc_publisher_settings *Einstellungen, otc_bool (aktiviert)
otc_status otc_publisher_settings_set_opus_dtx (otc_publisher_settings *Einstellungen, otc_bool (aktiviert)
otc_status otc_publisher_settings_set_auto_gain_control (otc_publisher_settings *Einstellungen, otc_bool (aktiviert)
otc_status otc_publisher_settings_set_noise_suppression (otc_publisher_settings *Einstellungen, otc_bool (aktiviert)
otc_status otc_publisher_settings_set_echo_cancellation (otc_publisher_settings *Einstellungen, otc_bool (aktiviert)
otc_status otc_publisher_settings_set_disable_audio_processing (otc_publisher_settings *Einstellungen, otc_bool (deaktiviert)
otc_status otc_publisher_settings_set_default_camera_capture_resolution (otc_publisher_settings *Einstellungen, konstante Aufzählung otc_camera_capture_resolution (camera_capture_resolution)
otc_status otc_publisher_settings_set_scalable_screenshare (otc_publisher_settings *Einstellungen, const otc_bool (aktiviert)
otc_status otc_publisher_settings_set_allow_audio_capture_while_muted (otc_publisher_settings *Einstellungen, const otc_bool (aktiviert)
otc_publisher * otc_publisher_new_with_settings (const struct otc_publisher_callbacks *Callbacks, otc_publisher_settings *Einstellungen)
otc_status otc_publisher_delete (otc_publisher *Verlag)
otc_stream * otc_publisher_get_stream (otc_publisher *Verlag)
otc_status otc_publisher_set_publish_video (otc_publisher *Verlag, otc_bool publish_video)
otc_status otc_publisher_set_publish_audio (otc_publisher *Verlag, otc_bool publish_audio)
otc_status otc_publisher_set_publish_captions (otc_publisher *Verlag, otc_bool publish_captions)
otc_bool otc_publisher_get_publish_video (const otc_publisher *Verlag)
otc_bool otc_publisher_get_publish_audio (const otc_publisher *Verlag)
otc_bool otc_publisher_get_publish_captions (const otc_publisher *Verlag)
otc_session * otc_publisher_get_session (const otc_publisher *Verlag)
otc_status otc_publisher_set_max_audio_bitrate (otc_publisher *publisher, uint32_t bitrate)
otc_status otc_publisher_set_rtc_stats_report_cb (otc_publisher *publisher, const struct otc_publisher_rtc_stats_report_cb cb)
otc_status otc_publisher_get_rtc_stats_report (const otc_publisher *Verlag)
otc_status otc_publisher_set_audio_fallback_enabled (otc_publisher *Verlag, otc_bool (aktiviert)
otc_bool otc_publisher_get_audio_fallback_enabled (const otc_publisher *Verlag)
const char * otc_publisher_get_publisher_id (const otc_publisher *Verlag)
otc_status otc_publisher_set_video_type (struct otc_publisher *Verlag, Aufzählung otc_publisher_video_type video_type)
enum otc_publisher_video_type otc_publisher_get_video_type (const struct otc_publisher *Verlag)
void * otc_publisher_get_user_data (const struct otc_publisher *Verlag)
const char * otc_publisher_get_name (const struct otc_publisher *Verlag)
otc_status otc_publisher_set_video_transformers (otc_publisher *Verlag, otc_video_transformer **transformers, uint8_t size)
Weist dem Videostream dieses Publishers ein Array von Videotransformatoren zu. Bei „null“ werden die Transformatoren zurückgesetzt. Mehr...
otc_status otc_publisher_set_audio_transformers (otc_publisher *Verlag, otc_audio_transformer **transformers, uint8_t size)
Weist dem Audiostream dieses Publishers ein Array von Audio-Transformatoren zu. Bei „null“ werden die Transformatoren zurückgesetzt. Mehr...
otc_status otc_publisher_set_max_video_bitrate (otc_publisher *publisher, int bitrate_bps)
Ruft die maximale Videobitrate ab, die für den Videostream dieses Publishers festgelegt ist. Mehr...
int otc_publisher_get_max_video_bitrate (const otc_publisher *Verlag)
Ruft die maximale Videobitrate ab, die für den Videostream dieses Publishers festgelegt ist. Mehr...
otc_status otc_publisher_set_video_bitrate_preset (otc_publisher *Verlag, Aufzählung otc_video_bitrate_preset Voreinstellung)
Legt eine Voreinstellung für die Videobitrate des Videostreams dieses Herausgebers fest. Mehr...
enum otc_video_bitrate_preset otc_publisher_get_video_bitrate_preset (const otc_publisher *Verlag)
Ruft die derzeit aktive Voreinstellung für die Videobitrate des Streams dieses Publishers ab. Mehr...
otc_status otc_publisher_settings_set_subscriber_audio_fallback_enabled (otc_publisher_settings *Einstellungen, const otc_bool (aktiviert)
otc_status otc_publisher_settings_set_publisher_audio_fallback_enabled (otc_publisher_settings *Einstellungen, const otc_bool (aktiviert)

Ausführliche Beschreibung

OpenTok Publisher.

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

Typedef-Dokumentation

otc_publisher

typedef struct otc_publisher otc_publisher

Definition des OpenTok-Publisher-Typs.

Ein Typ, der einen Anbieter eines Audio-Video-Streams für eine OpenTok-Sitzung darstellt.

otc_publisher_settings

Typdefinition für OpenTok-Publisher-Einstellungen.

Dokumentation zu Aufzählungstypen

otc_publisher_error_code

Auflistung der Fehlercodes für OpenTok-Publisher.

Diese Aufzählung enthält verschiedene Fehlercodes, die mit einem Herausgeber in Verbindung stehen.

Zähler
OTC_PUBLISHER_INTERNAL_ERROR Interner Fehler.
OTC_PUBLISHER_SESSION_DISCONNECTED Fehler beim Versuch, Untertitel in einer Sitzung zu starten, mit der Sie nicht verbunden sind.
OTC_PUBLISHER_TIMED_OUT Zeitüberschreitung beim Versuch, den Beitrag zu veröffentlichen.
OTC_PUBLISHER_UNABLE_TO_PUBLISH Fehler beim Veröffentlichen.
OTC_PUBLISHER_WEBRTC_ERROR WebRTC-Fehler.
OTC_PUBLISHER_ENCRYPTION_INTERNAL_ERROR Interner Fehler beim Verschlüsseln eines Pakets
OTC_PUBLISHER_ENCRYPTION_UNSUPPORTED_CODEC Nicht unterstützter Medien-Codec für die Verschlüsselung

otc_publisher_video_type

Auflistung der Videoformate des Herausgebers.

Diese Aufzählung enthält die verschiedenen unterstützten Videotypen.

Zähler
OTC_PUBLISHER_VIDEO_TYPE_CAMERA Videostream der Kamera.
OTC_PUBLISHER_VIDEO_TYPE_SCREEN Bildschirmaufnahme des Videostreams.

otc_video_bitrate_preset

Voreingestellte Strategien zur Steuerung der Video-Bitrate im Stream eines Anbieters.

Mit diesen Voreinstellungen können Entwickler Bandbreitenstrategien anwenden, ohne die Bitraten manuell festlegen zu müssen. Die Voreinstellungen schließen eine manuelle Bitratenkonfiguration aus.

Für weitere Informationen siehe Herausgeber Maximale Bitrate.

Zähler
OTC_VIDEO_BITRATE_PRESET_DEFAULT Standardvoreinstellung. Es gelten keine zusätzlichen Einschränkungen. Dies ist der Standardmodus.
OTC_VIDEO_BITRATE_PRESET_BW_SAVER Voreinstellung „Bandbreitenschoner“. Wendet moderate Einschränkungen an, um die Bandbreitennutzung zu reduzieren und gleichzeitig eine angemessene Videoqualität zu gewährleisten.
OTC_VIDEO_BITRATE_PRESET_EXTRA_BW_SAVER Zusätzliche Voreinstellung zur Bandbreiteneinsparung. Wendet strenge Einschränkungen an, um die Bandbreitennutzung zu minimieren.
OTC_VIDEO_BITRATE_PRESET_CUSTOM Benutzerdefinierte Bitrate. Bezeichnet eine manuell konfigurierte Bitrate unter Verwendung von otc_publisher_set_max_video_bitrate(). Dieser Wert wird vom Preset-Getter ausschließlich zu internen Nachverfolgungszwecken zurückgegeben und kann nicht an den Preset-Setter übergeben werden.

Funktionsdokumentation

otc_publisher_delete()

otc_status otc_publisher_delete ( otc_publisher * Herausgeber )

Gibt eine Publisher-Instanz frei, einschließlich aller damit verknüpften Hardware-Ressourcen.

Parameter : | | | | --- | --- | | publisher | Die zu löschende Publisher-Instanz. |

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

otc_publisher_get_audio_fallback_enabled()

otc_bool otc_publisher_get_audio_fallback_enabled ( const otc_publisher * Herausgeber )

Gibt zurück, ob die Audio-Fallback-Funktion des Anbieters aktiviert ist oder nicht. Siehe die otc_publisher_set_audio_fallback_enabled Funktion.

Diese Funktion ist veraltet.

Parameter : | | | | --- | --- | | publisher | Die Publisher-Instanz. |

Rückgaben : Gibt an, ob die Audio-Fallback-Funktion des Anbieters aktiviert ist oder nicht.

otc_publisher_get_max_video_bitrate()

int otc_publisher_get_max_video_bitrate ( const otc_publisher * Herausgeber )

Ruft die maximale Videobitrate ab, die für den Videostream dieses Publishers festgelegt ist.

Gibt die aktuell konfigurierte maximale Video-Bitrate in Bit pro Sekunde (bps) zurück. Wenn keine manuelle Bitrate über otc_publisher_set_max_video_bitrate(), oder wenn eine Voreinstellung aktiv ist (einschließlich der Standardeinstellung), gibt diese Funktion 0 zurück.

Anmerkung: Ein Rückgabewert von 0 bedeutet, dass keine explizite Bitratenbegrenzung angewendet wird und der Stream stattdessen auf voreingestellten Werten basiert.

Parameter : | | | | | --- | --- | --- | | [in] | publisher | Die Publisher-Instanz. |

Rückgabewert : Die aktuelle maximale Video-Bitrate in Bit pro Sekunde oder 0, falls nicht manuell festgelegt.

otc_publisher_get_name()

const char * otc_publisher_get_name ( const struct otc_publisher * Herausgeber )

Ruft den Namen eines bestimmten Herausgebers ab.

Parameter : | | | | --- | --- | | publisher | Die Publisher-Instanz. |

Rückgabewert : Der Name.

otc_publisher_get_publish_audio()

otc_bool otc_publisher_get_publish_audio ( const otc_publisher * Herausgeber )

Gibt zurück, ob der Publisher Audio sendet oder nicht.

Parameter : | | | | --- | --- | | publisher | Die Publisher-Instanz. |

Rückgaben : Gibt an, ob der Verlag Hörbücher veröffentlicht oder nicht.

otc_publisher_get_publish_captions()

otc_bool otc_publisher_get_publish_captions ( const otc_publisher * Herausgeber )

Gibt zurück, ob beim Publisher Untertitel aktiviert sind.

Parameter : | | | | --- | --- | | publisher | Die Publisher-Instanz. |

Rückgaben : Gibt an, ob der Herausgeber Bildunterschriften aktiviert hat oder nicht.

otc_publisher_get_publish_video()

otc_bool otc_publisher_get_publish_video ( const otc_publisher * Herausgeber )

Gibt zurück, ob der Herausgeber ein Video veröffentlicht oder nicht.

Parameter : | | | | --- | --- | | publisher | Die Publisher-Instanz. |

Rückgaben : Gibt an, ob der Herausgeber Videos veröffentlicht oder nicht.

otc_publisher_get_publisher_id()

const char * otc_publisher_get_publisher_id ( const otc_publisher * Herausgeber )

Ruft eine eindeutige Kennung für einen Herausgeber ab.

Parameter : | | | | --- | --- | | publisher | Die Publisher-Instanz. |

Rückgabewerte : Eine eindeutige Kennung für den Herausgeber. Im Fehlerfall ist dieser Wert null.

otc_publisher_get_rtc_stats_report()

otc_status otc_publisher_get_rtc_stats_report ( const otc_publisher * Herausgeber )

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

Siehe auch otc_publisher_callbacks.on_audio_stats, otc_publisher_callbacks.on_video_statsund otc_subscriber_get_rtc_stats_report.

Parameter : | | | | --- | --- | | Herausgeber | Der Herausgeber. |

otc_publisher_get_session()

otc_session * otc_publisher_get_session ( const otc_publisher * Herausgeber )

Gibt die otc_session dieser Publisher-Instanz zugeordnet.

Parameter : | | | | --- | --- | | publisher | Die Publisher-Instanz. |

Rücksendungen : Die otc_session dieser Instanz zugeordnet. Im Fehlerfall ist der Wert null.

otc_publisher_get_stream()

otc_stream * otc_publisher_get_stream ( otc_publisher * Herausgeber )

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

Parameter : | | | | --- | --- | | publisher | Die Publisher-Instanz, von der der Stream abgerufen werden soll. |

Rückgabewert : Der mit dem Publisher verknüpfte Stream. Bei einem Fehler ist dieser Wert null.

otc_publisher_get_user_data()

void * otc_publisher_get_user_data ( const struct otc_publisher * Herausgeber )

Ruft die Benutzerdaten für einen bestimmten Herausgeber ab.

Parameter : | | | | --- | --- | | publisher | Die Publisher-Instanz. |

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

otc_publisher_get_video_bitrate_preset()

enum otc_video_bitrate_preset otc_publisher_get_video_bitrate_preset ( const otc_publisher * Herausgeber )

Ruft die derzeit aktive Voreinstellung für die Videobitrate des Streams dieses Publishers ab.

Wenn zuvor mithilfe von otc_publisher_set_max_video_bitrate(), gibt diese Methode den Wert „OTC_VIDEO_BITRATE_PRESET_CUSTOM“ zurück.

Parameter : | | | | | --- | --- | --- | | [in] | publisher | Die Publisher-Instanz. |

Rückgabewerte : Die aktive Bitrate-Voreinstellung.

otc_publisher_get_video_type()

enum otc_publisher_video_type otc_publisher_get_video_type ( const struct otc_publisher * Herausgeber )

Ruft den Videotyp des Herausgebers ab. Siehe die otc_publisher_set_video_type Funktion.

Parameter : | | | | --- | --- | | publisher | Die Publisher-Instanz. |

Rückgabewerte : Der Videotyp des Herausgebers.

otc_publisher_new()

otc_publisher * otc_publisher_new ( const char * Name,
const struct otc_video_capturer_callbacks * Aufnehmer,
const struct otc_publisher_callbacks * Rückrufe
)

Erstellt eine neue „otc_publisher“-Instanz.

Parameter : | | | | --- | --- | | name | Der Name des Publishers. Andere Clients können die Namen der Streams in der Sitzung abrufen. | | capturer | Verwenden Sie diesen Parameter, wenn Sie einen benutzerdefinierten Video-Capturer bereitstellen möchten. Ist er auf null gesetzt, verwendet der Publisher einen Standard-Video-Capturer, der die Kamera des Systems nutzt. | | callbacks | Ein Zeiger auf die Struktur mit den Zeigern auf die Callback-Funktionen des Publishers. |

Rückgabewert : Eine neue Instanz von `otc_publisher`. Bei einem Fehler ist der Wert `null`.

otc_publisher_new_with_settings()

otc_publisher * otc_publisher_new_with_settings ( const struct otc_publisher_callbacks * Rückrufe,
otc_publisher_settings * Einstellungen
)

Erstellt eine neue „otc_publisher“-Instanz.

Parameter : | | | | --- | --- | | callbacks | Ein Zeiger auf die Struktur mit den Zeigern auf die Callback-Funktionen des Publishers. | | settings | Die Struktur „settings“, die die gewünschten Einstellungen für den Publisher enthält. |

Rückgabewert : Eine neue Instanz von `otc_publisher`. Bei einem Fehler ist der Wert `null`.

otc_publisher_set_audio_fallback_enabled()

otc_status otc_publisher_set_audio_fallback_enabled ( otc_publisher * Herausgeber,
otc_bool aktiviert
)

Aktiviert oder deaktiviert die Audio-Fallback-Funktion für Teilnehmer.

Die Audio-Fallback-Funktion ist in Sitzungen verfügbar, die den OpenTok Media Router verwenden. Ist die Audio-Fallback-Funktion aktiviert (Standardeinstellung), deaktiviert der OpenTok Media Router das Video für einen bestimmten Teilnehmer, sobald er feststellt, dass die Qualität eines Streams für diesen Teilnehmer erheblich nachgelassen hat, um die Audioqualität zu gewährleisten.

Um die Audio-Fallback-Funktion zu deaktivieren, rufen Sie die otc_publisher_set_audio_fallback_enabled Funktion (und übergebe dabei OTC_FALSE), bevor du die otc_session_publish Funktion.

Diese Funktion ist veraltet. Siehe otc_publisher_settings_set_subscriber_audio_fallback_enabled.

Parameter : | | | | --- | --- | | publisher | Der betroffene Publisher. | | enabled | Gibt an, ob die Audio-Fallback-Funktion aktiviert werden soll oder nicht. |

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

otc_publisher_set_audio_transformers()

otc_status otc_publisher_set_audio_transformers ( otc_publisher * Herausgeber,
otc_audio_transformer ** Transformatoren,
uint8_t Größe
)

Weist dem Audiostream dieses Publishers ein Array von Audio-Transformatoren zu. Bei „null“ werden die Transformatoren zurückgesetzt.

Das Array kann aus von der ml-Bibliothek bereitgestellten Vonage-Audio-Transformatoren und/oder benutzerdefinierten Transformatoren bestehen. Transformatoren enthalten einen Zeiger auf einen Callback, der bei jedem Audio-Frame aufgerufen wird.

Anmerkung: Diese Funktion gilt nur für das Vonage Video API macOS SDK. Im Vonage Video API Linux SDK funktioniert sie nicht.

Parameter : | | | | | --- | --- | --- | | [in] | publisher | Die Publisher-Instanz. | | [in] | transformers | Array aus undurchsichtigen Zeigern auf `otc_audio_transformer` in der Reihenfolge, in der sie auf den Stream angewendet werden sollen. | | [in] | size | Größe des Arrays. |

Rückgabewerte : im Fehlerfall einen Fehler, andernfalls OTC_SUCCESS.

otc_publisher_set_max_audio_bitrate()

otc_status otc_publisher_set_max_audio_bitrate ( otc_publisher * Herausgeber,
uint32_t Bitrate
)

Legt die maximale Audio-Bitrate für den Publisher fest.

Parameter : | | | | --- | --- | | publisher | Der betroffene Publisher. | | bitrate | Die gewünschte Bitrate in kbps. |

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

otc_publisher_set_max_video_bitrate()

otc_status otc_publisher_set_max_video_bitrate ( otc_publisher * Herausgeber,
int bitrate_bps
)

Ruft die maximale Videobitrate ab, die für den Videostream dieses Publishers festgelegt ist.

Gibt die aktuelle maximale Videobitrate in Bit pro Sekunde (bps) zurück. Wenn keine Bitrate explizit über otc_publisher_set_max_video_bitrate(), oder wenn eine Bitrate-Voreinstellung aktiv ist (einschließlich der Standardvoreinstellung), gibt diese Funktion den Wert 0 zurück.

Anmerkung: Ein Rückgabewert von 0 bedeutet, dass keine manuelle Bitratenbegrenzung aktiv ist und der Stream mit einer voreingestellten Konfiguration läuft.

Parameter : | | | | | --- | --- | --- | | [in] | publisher | Die Publisher-Instanz. |

Rückgabewert : Die aktuelle maximale Video-Bitrate in Bit pro Sekunde oder 0, wenn kein Wert festgelegt wurde oder eine Voreinstellung verwendet wird.

otc_publisher_set_publish_audio()

otc_status otc_publisher_set_publish_audio ( otc_publisher * Herausgeber,
otc_bool Audio veröffentlichen
)

Ob Audio übertragen werden soll oder nicht. Standardmäßig werden bei Streams sowohl Audio als auch Video übertragen.

Parameter : | | | | --- | --- | | publisher | Der betroffene Publisher. | | publish_audio | Gibt an, ob Audio veröffentlicht werden soll oder nicht. |

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

otc_publisher_set_publish_captions()

otc_status otc_publisher_set_publish_captions ( otc_publisher * Herausgeber,
otc_bool Bildunterschriften veröffentlichen
)

Ob Untertitel aktiviert werden sollen oder nicht. Standardmäßig ist diese Option deaktiviert.

Parameter : | | | | --- | --- | | publisher | Der betroffene Publisher. | | publish_captions | Gibt an, ob Untertitel aktiviert werden sollen oder nicht. |

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

otc_publisher_set_publish_video()

otc_status otc_publisher_set_publish_video ( otc_publisher * Herausgeber,
otc_bool Video veröffentlichen
)

Ob Video übertragen werden soll oder nicht. Standardmäßig werden bei Streams sowohl Audio als auch Video übertragen.

Parameter : | | | | --- | --- | | publisher | Der betroffene Publisher. | | publish_video | Gibt an, ob das Video veröffentlicht werden soll oder nicht. |

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

otc_publisher_set_rtc_stats_report_cb()

otc_status otc_publisher_set_rtc_stats_report_cb ( otc_publisher * Herausgeber,
const struct otc_publisher_rtc_stats_report_cb cb
)

Legt den Callback für den RTC-Statistikbericht beim Publisher fest.

Parameter : | | | | --- | --- | | publisher | Die Publisher-Instanz. | | cb | Die otc_publisher_rtc_stats_report_cb Struktur, die die Callback-Funktion für den RTC-Statistikbericht enthält. |

Siehe auch : otc_publisher_get_rtc_stats_report.

otc_publisher_set_video_bitrate_preset()

otc_status otc_publisher_set_video_bitrate_preset ( otc_publisher * Herausgeber,
enum otc_video_bitrate_preset Voreinstellung
)

Legt eine Voreinstellung für die Videobitrate des Videostreams dieses Herausgebers fest.

Wendet eine vordefinierte Strategie für die Videobitrate an, um das Verhalten des Encoders zu steuern. Diese Voreinstellungen dienen dazu, je nach den Anforderungen der Applications ein Gleichgewicht zwischen Videoqualität und Bandbreitennutzung herzustellen.

Anmerkung: Die Voreinstellung „OTC_VIDEO_BITRATE_PRESET_CUSTOM“ kann nicht direkt festgelegt werden. Der Aufruf von otc_publisher_set_max_video_bitrate() überschreibt die Voreinstellung und bewirkt, dass der Preset-Getter den Wert OTC_VIDEO_BITRATE_PRESET_CUSTOM zurückgibt.

Parameter : | | | | | --- | --- | --- | | [in] | publisher | Die Publisher-Instanz. | | [in] | preset | Ein Wert aus otc_video_bitrate_preset um sich zu bewerben. |

Rückgabewerte : im Fehlerfall einen Fehler, andernfalls OTC_SUCCESS.

otc_publisher_set_video_transformers()

otc_status otc_publisher_set_video_transformers ( otc_publisher * Herausgeber,
otc_video_transformer ** Transformatoren,
uint8_t Größe
)

Weist dem Videostream dieses Publishers ein Array von Videotransformatoren zu. Bei „null“ werden die Transformatoren zurückgesetzt.

Das Array kann aus von der ml-Library bereitgestellten Vonage-Video-Transformatoren und/oder benutzerdefinierten Transformatoren bestehen. Transformatoren enthalten einen Zeiger auf einen Callback, der bei jedem Videobild aufgerufen wird.

Anmerkung: Diese Funktion gilt nur für das Vonage Video API macOS SDK. Im Vonage Video API Linux SDK funktioniert sie nicht.

Parameter : | | | | | --- | --- | --- | | [in] | publisher | Die Publisher-Instanz. | | [in] | transformers | Array aus undurchsichtigen Zeigern auf `otc_video_transformer` in der Reihenfolge, in der sie auf den Stream angewendet werden sollen. | | [in] | size | Größe des Arrays. |

Rückgabewerte : im Fehlerfall einen Fehler, andernfalls OTC_SUCCESS.

otc_publisher_set_video_type()

otc_status otc_publisher_set_video_type ( struct otc_publisher * Herausgeber,
enum otc_publisher_video_type videotyp
)

Legt den Videotyp des Publishers fest. Standardmäßig ist der Videotyp auf „OTC_PUBLISHER_VIDEO_TYPE_CAMERA“ gesetzt (was angibt, dass die Quelle des Videos eine Kamera ist). Setzen Sie diesen Wert auf „OTC_PUBLISHER_VIDEO_TYPE_SCREEN“, um anzugeben, dass die Videoquelle eine Bildschirmfreigabe ist. Andere Clients können den Videotyp für Streams in der Sitzung erkennen (um den Typ der Videoquelle zu bestimmen).

Parameter : | | | | --- | --- | | publisher | Der betroffene Publisher. | | video_type | Der Videotyp für den Publisher. |

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

otc_publisher_settings_delete()

otc_status otc_publisher_settings_delete ( otc_publisher_settings * Einstellungen )

Löscht eine „otc_publisher_settings“-Instanz.

Parameter : | | | | --- | --- | | settings | Die zu löschende Instanz „otc_publisher_settings“. |

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

otc_publisher_settings_new()

otc_publisher_settings * otc_publisher_settings_new ( )

Erstellt eine neue Instanz von „otc_publisher_settings“.

Gibt zurück : Eine neue Instanz von `otc_publisher_settings`

otc_publisher_settings_set_allow_audio_capture_while_muted()

otc_status otc_publisher_settings_set_allow_audio_capture_while_muted ( otc_publisher_settings * Einstellungen,
const otc_bool aktiviert
)

Wenn otc_publisher_settings_set_allow_audio_capture_while_muted wird eingestellt auf false, wird das Mikrofon automatisch ausgeschaltet, sobald alle Redner ihr Mikrofon stummgeschaltet haben. Das Mikrofon wird automatisch wieder eingeschaltet, sobald mindestens ein Redner sein Mikrofon wieder einschaltet. Bei der Einstellung true, Das Mikrofon bleibt immer eingeschaltet, auch wenn alle Publisher ihren Ton stummgeschaltet haben. Beachten Sie, dass bei ausgeschaltetem Mikrofon Callbacks wie „audio_level“ oder „audio_data“ für die Publisher nicht mehr aufgerufen werden. Der Standardwert ist true. Siehe otc_session_new_with_settings.

Parameter : | | | | --- | --- | | settings | Zeiger auf das Objekt mit den Sitzungseinstellungen. | | enable | Boolescher Wert zum Deaktivieren (OTC_FALSE, Standardwert) oder Aktivieren (OTC_TRUE) dieses Flags. |

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

otc_publisher_settings_set_audio_track()

otc_status otc_publisher_settings_set_audio_track ( otc_publisher_settings * Einstellungen,
otc_bool aktiviert
)

Ermöglicht die Erstellung einer Audiospur für einen Herausgeber mit otc_publisher_new_with_settings.

Parameter : | | | | --- | --- | | settings | Die betroffene Instanz von „otc_publisher_settings“. | | enabled | Aktiviert bzw. deaktiviert die Erstellung einer Audiospur für einen Publisher, die mit otc_publisher_new_with_settings. |

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

otc_publisher_settings_set_auto_gain_control()

otc_status otc_publisher_settings_set_auto_gain_control ( otc_publisher_settings * Einstellungen,
otc_bool aktiviert
)

Ermöglicht die automatische Lautstärkeregelung für einen Publisher, der mit folgenden Komponenten erstellt wird: otc_publisher_new_with_settings.

Im Vonage Video API Linux SDK funktioniert es nicht.

Parameter : | | | | --- | --- | | settings | Die betroffene Instanz von „otc_publisher_settings“. | | enabled | Gibt an, ob die automatische Verstärkungsregelung aktiviert (true, Standard) oder deaktiviert (false) werden soll. |

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

otc_publisher_settings_set_default_camera_capture_resolution()

otc_status otc_publisher_settings_set_default_camera_capture_resolution ( otc_publisher_settings * Einstellungen,
const enum otc_camera_capture_resolution Kameraauflösung
)

Legt die Aufnahmeauflösung für die Standard-Videoaufzeichnungsfunktionen fest.

Benutzerdefinierte Videoaufzeichnungsgeräte sollten die von otc_publisher_settings_set_default_camera_capture_resolution, dies gilt jedoch nur für Standard-Videoaufzeichnungsprogramme.

Parameter : | | | | --- | --- | | camera_capture_resolution | Die Aufnahmeauflösung der Kamera für Standard-Videoaufzeichnungsgeräte. | | settings | Die betroffene Instanz von „otc_publisher_settings“. |

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

otc_publisher_settings_set_disable_audio_processing()

otc_status otc_publisher_settings_set_disable_audio_processing ( otc_publisher_settings * Einstellungen,
otc_bool deaktiviert
)

Wenn otc_publisher_settings_set_disable_audio_processing wird eingestellt auf true, werden die individuellen Einstellungen für die akustische Echounterdrückung, die automatische Verstärkungsregelung und die Rauschunterdrückung ignoriert, und das Audiosignal wird überhaupt nicht verarbeitet. Der Standardwert ist false. Siehe otc_publisher_new_with_settings.

Parameter : | | | | --- | --- | | settings | Die betroffene Instanz von „otc_publisher_settings“. | | enabled | Gibt an, ob die Unterstützung für die Audioverarbeitung aktiviert (true) oder deaktiviert (false, Standard) werden soll. |

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

otc_publisher_settings_set_echo_cancellation()

otc_status otc_publisher_settings_set_echo_cancellation ( otc_publisher_settings * Einstellungen,
otc_bool aktiviert
)

Ermöglicht die akustische Echokompensation, damit ein Sender mit folgenden Komponenten aufgebaut werden kann: otc_publisher_new_with_settings.

Anmerkung: Diese Funktion gilt nur für das Vonage Video API macOS SDK. Im Vonage Video API Linux SDK funktioniert sie nicht.

Parameter : | | | | --- | --- | | settings | Die betroffene Instanz von „otc_publisher_settings“. | | enabled | Gibt an, ob die Unterstützung für die akustische Echokompensation aktiviert (true, Standard) oder deaktiviert (false) werden soll. |

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

otc_publisher_settings_set_name()

otc_status otc_publisher_settings_set_name ( otc_publisher_settings * Einstellungen,
const char * Name
)

Legt den gewünschten Namen für einen zu erstellenden Herausgeber fest otc_publisher_new_with_settings.

Parameter : | | | | --- | --- | | settings | Die betroffene Instanz von „otc_publisher_settings“. | | name | Der Name des Publishers. Andere Clients können die Namen der Streams in der Sitzung abrufen. |

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

otc_publisher_settings_set_noise_suppression()

otc_status otc_publisher_settings_set_noise_suppression ( otc_publisher_settings * Einstellungen,
otc_bool aktiviert
)

Ermöglicht die Rauschunterdrückung für einen Publisher, der mit folgenden Elementen aufgebaut wird: otc_publisher_new_with_settings.

Anmerkung: Diese Funktion gilt nur für das Vonage Video API macOS SDK. Im Vonage Video API Linux SDK funktioniert sie nicht.

Parameter : | | | | --- | --- | | settings | Die betroffene Instanz von „otc_publisher_settings“. | | enabled | Gibt an, ob die Rauschunterdrückung aktiviert (true, Standard) oder deaktiviert (false) werden soll. |

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

otc_publisher_settings_set_opus_dtx()

otc_status otc_publisher_settings_set_opus_dtx ( otc_publisher_settings * Einstellungen,
otc_bool aktiviert
)

Aktiviert Opus DTX damit ein Publisher erstellt werden kann mit otc_publisher_new_with_settings. Durch die Aktivierung von Opus DTX lässt sich der Bandbreitenverbrauch bei Streams mit langen Stillphasen reduzieren.

Parameter : | | | | --- | --- | | settings | Die betroffene Instanz von „otc_publisher_settings“. | | enabled | Gibt an, ob die Opus-DTX-Unterstützung aktiviert (true) oder deaktiviert (false, Standard) werden soll. |

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

otc_publisher_settings_set_publisher_audio_fallback_enabled()

otc_status otc_publisher_settings_set_publisher_audio_fallback_enabled ( otc_publisher_settings * Einstellungen,
const otc_bool aktiviert
)

Aktiviert oder deaktiviert die Audio-Fallback-Funktion des Herausgebers.

Wenn die Audio-Fallback-Funktion des Publishers aktiviert ist und der Publisher feststellt, dass sich die Qualität eines Streams erheblich verschlechtert hat, deaktiviert er den Videostream, um die Audioqualität zu erhalten, und sendet den Audiostream weiterhin. Der diesem Publisher zugeordnete Capturer wird nicht deaktiviert, und die erfassten Frames sind auf der Publisher-Seite weiterhin sichtbar.

Die Standardeinstellung lautet OTC_FALSE (die Audio-Fallback-Funktion ist deaktiviert). Bei Verwendung des Bildschirmvideo-Typs in einer Sitzung, die den OpenTok Media Server nutzt, ist die Audio-Fallback-Einstellung des Publishers standardmäßig auf OTC_FALSE gesetzt, damit das Video bei den Abonnenten nicht ausfällt.

Parameter : | | | | --- | --- | | Einstellungen | Die betroffenen Publisher-Einstellungen. | | aktiviert | Ob die Audio-Fallback-Funktion aktiviert werden soll oder nicht. |

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

otc_publisher_settings_set_scalable_screenshare()

otc_status otc_publisher_settings_set_scalable_screenshare ( otc_publisher_settings * Einstellungen,
const otc_bool aktiviert
)

Verwendung von skalierbarem Video zulassen skalierbares Video für einen Verlag, der über die otc_publisher_video_type eingestellt auf OTC_PUBLISHER_VIDEO_TYPE_SCREEN mit otc_publisher_new_with_settings.

Parameter : | | | | --- | --- | | settings | Die betroffene Instanz von „otc_publisher_settings“. | | enabled | Aktivieren/Deaktivieren der Verwendung von skalierbarem Video für Bildschirmfreigabe-Streams. |

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

otc_publisher_settings_set_stereo()

otc_status otc_publisher_settings_set_stereo ( otc_publisher_settings * Einstellungen,
otc_bool aktiviert
)

Ermöglicht die Erstellung von Stereo-Audio für einen Herausgeber mit otc_publisher_new_with_settings.

Parameter : | | | | --- | --- | | settings | Die betroffene Instanz von „otc_publisher_settings“. | | enabled | Aktiviert bzw. deaktiviert die Stereo-Audio-Unterstützung für einen Publisher, der mit otc_publisher_new_with_settings. |

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

otc_publisher_settings_set_subscriber_audio_fallback_enabled()

otc_status otc_publisher_settings_set_subscriber_audio_fallback_enabled ( otc_publisher_settings * Einstellungen,
const otc_bool aktiviert
)

Aktiviert oder deaktiviert die Audio-Fallback-Funktion für Abonnenten (für Abonnenten des veröffentlichten Streams)

Die Audio-Fallback-Funktion für Teilnehmer ist in Sitzungen verfügbar, die den OpenTok Media Router nutzen. Ist die Audio-Fallback-Funktion aktiviert (Standardeinstellung), deaktiviert der OpenTok Media Router das Video für einen bestimmten Teilnehmer, sobald er feststellt, dass die Qualität eines Streams für diesen Teilnehmer erheblich abgenommen hat, um die Audioqualität zu gewährleisten.

Die Standardeinstellung lautet OTC_TRUE (die Audio-Fallback-Funktion ist aktiviert). Bei Verwendung des Bildschirm-Videotyps ist die Audio-Fallback-Einstellung für Teilnehmer standardmäßig auf OTC_FALSE gesetzt, damit das Video bei den Teilnehmern nicht ausfällt.

Parameter : | | | | --- | --- | | Einstellungen | Die betroffenen Publisher-Einstellungen. | | aktiviert | Ob die Audio-Fallback-Funktion aktiviert werden soll oder nicht. |

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

otc_publisher_settings_set_video_capturer()

otc_status otc_publisher_settings_set_video_capturer ( otc_publisher_settings * Einstellungen,
const struct otc_video_capturer_callbacks * Aufnehmer
)

Legt fest, mit welchem Video-Capturer ein Publisher erstellt werden soll otc_publisher_new_with_settings.

Parameter : | | | | --- | --- | | settings | Die betroffene Instanz von „otc_publisher_settings“. | | capturer | Der Video-Capturer. |

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

otc_publisher_settings_set_video_track()

otc_status otc_publisher_settings_set_video_track ( otc_publisher_settings * Einstellungen,
otc_bool aktiviert
)

Ermöglicht die Erstellung einer Videospur für einen Publisher mit otc_publisher_new_with_settings.

Parameter : | | | | --- | --- | | settings | Die betroffene Instanz von „otc_publisher_settings“. | | enabled | Aktiviert bzw. deaktiviert die Erstellung einer Videospur für einen Publisher mit otc_publisher_new_with_settings. |

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