class Audio::P ushAudioInputStream

class Audio::PushAudioInputStream
  : public Audio::AudioInputStream

Stellt speichergesicherte Push-Audioeingabedatenstrom dar, der für benutzerdefinierte Audioeingabekonfigurationen verwendet wird.

Elemente

~PushAudioInputStream

Syntax: public inline virtual ~PushAudioInputStream ( );

Destruktor; schließt den zugrunde liegenden Datenstrom, wenn er noch nicht geschlossen wurde.

Schreiben

Syntax: public inline void Write ( uint8_t * dataBuffer , uint32_t size );

Schreibt die audiodaten, die durch eine interne Kopie der Daten angegeben werden. Hinweis: Der dataBuffer darf keine Audioheader enthalten.

Die Parameter

• dataBuffer Der Zeiger auf den Audiopuffer, von dem diese Funktion eine Kopie erstellen soll.

• size Die Größe des Puffers.

SetProperty

Syntax: public inline void SetProperty ( PropertyId id , const SPXSTRING & value );

Legen Sie den Wert einer Eigenschaft fest. Die Eigenschaften der Audiodaten sollten vor dem Schreiben der Audiodaten festgelegt werden. In Version 1.5.0 hinzugefügt.

Die Parameter

• id Die ID der Eigenschaft. Siehe PropertyId

• value festzulegenden Wert

SetProperty

Syntax: public inline void SetProperty ( const SPXSTRING & propertyName , const SPXSTRING & value );

Legen Sie den Wert einer Eigenschaft fest. Die Eigenschaften der Audiodaten sollten vor dem Schreiben der Audiodaten festgelegt werden. In Version 1.5.0 hinzugefügt.

Die Parameter

• propertyName Der Name der Eigenschaft.

• value festzulegenden Wert

Schließen

Syntax: public inline void Close ( );

Schließt den Datenstrom.

Commit

Syntax: public inline uint32_t Commit ( );

Bittet darum, dass das bisher geschriebene Audio als fertiges Segment eingetragen wird. Nicht blockierend; kehrt sofort mit einem Korrelationstoken zurück.

Rückgaben

Ein Commit-Token >= 1, das mit der CommitToken-Eigenschaft bei einem weiteren Recognized Event abgeglichen werden kann, oder 0, wenn der Anruf direkt abgelehnt wurde, z. B. basierend auf dem SDK-lokalen Rate-Limit (höchstens ein erfolgreicher Commit() pro 100 ms pro Push-Stream).

Ein zurückgegebenes nicht-null Token garantiert kein entsprechendes Recognized Event; der Commit kann stillschweigend verworfen werden, wenn der Dienst die Funktion nicht unterstützt oder wenn die Sitzung abgebaut wird, bevor die Bestätigung eintrifft. Ein Commit, der noch nicht geliefert wurde, wird ebenfalls verworfen, wenn das Ende des Audios signalisiert wird – durch Close() oder durch ein Write() mit leerem Puffer –, da der resultierende Flush bereits ein Ergebnis erzeugt, das das Audio abdeckt, an das der Commit verankert war.

Commit

Syntax: public inline uint32_t Commit ( uint32_t channelId );

Dasselbe wie Commit(), aber auf einen einzelnen Kanal eines Mehrkanal-Eingangs beschränkt. Der Dienst bestätigt die Verpflichtung nur auf dem benannten Kanal. Siehe Commit() für Rückgabe-Wert-Semantik.

Die Parameter

• channelId 0-indexierte Kanalkennung.

Rückgaben

Ein Commit-Token >= 1 oder 0, wenn der Anruf durch das SDK-lokale Rate-Limit abgelehnt wurde.

Erstellen

Syntax: public inline static std::shared_ptr< PushAudioInputStream > Create ( );

Erstellt einen speichergesicherten PushAudioInputStream mit dem Standardformat (16 kHz, 16 Bit, Mono PCM).

Rückgaben

Ein gemeinsam genutzter Zeiger auf PushAudioInputStream

Erstellen

Syntax: public inline static std::shared_ptr< PushAudioInputStream > Create ( std::shared_ptr< AudioStreamFormat > format );

Erstellt einen speichergesicherten PushAudioInputStream mit dem angegebenen Audioformat.

Die Parameter

• format Audiostreamformat.

Rückgaben

Ein gemeinsam genutzter Zeiger auf PushAudioInputStream