IAudioClient3::GetSharedModeEnginePeriod-Methode (audioclient.h)
Gibt den Periodizitätsbereich zurück, der vom Modul für das angegebene Datenstromformat unterstützt wird. Die Periodizität der Engine ist die Rate, mit der das Modul einen ereignisgesteuerten Audioclient aktiviert, um Audiodaten an oder von der Engine zu übertragen. Die zurückgegebenen Werte hängen von den Merkmalen des Audioclients ab, die durch einen vorherigen Aufruf von IAudioClient2::SetClientProperties angegeben wurden.
Syntax
HRESULT GetSharedModeEnginePeriod(
[in] const WAVEFORMATEX *pFormat,
[out] UINT32 *pDefaultPeriodInFrames,
[out] UINT32 *pFundamentalPeriodInFrames,
[out] UINT32 *pMinPeriodInFrames,
[out] UINT32 *pMaxPeriodInFrames
);
Parameter
[in] pFormat
Typ: const WAVEFORMATEX*
Das Streamformat, für das die unterstützten Periodizitäten abgefragt werden.
[out] pDefaultPeriodInFrames
Typ: UINT32*
Der Standardzeitraum, mit dem das Modul den Client für die Übertragung von Audiobeispielen reaktiviert
[out] pFundamentalPeriodInFrames
Typ: UINT32*
Der grundlegende Zeitraum, in dem das Modul den Client für die Übertragung von Audiobeispielen aktiviert. Wenn Sie die Periodizität der Audio-Engine festlegen, müssen Sie ein integrales Vielfaches dieses Werts verwenden.
[out] pMinPeriodInFrames
Typ: UINT32*
Der kürzeste Zeitraum in Audioframes, mit dem die Audio-Engine den Client für die Übertragung von Audiobeispielen aktiviert.
[out] pMaxPeriodInFrames
Typ: UINT32*
Der längste Zeitraum in Audioframes, mit dem die Audio-Engine den Client für die Übertragung von Audiobeispielen aktiviert.
Rückgabewert
Typ: HRESULT
Diese Methode gibt S_OK zurück, um anzugeben, dass sie erfolgreich abgeschlossen wurde. Andernfalls wird ein entsprechender Fehlercode zurückgegeben.
Hinweise
Audioclients fordern eine bestimmte Periodizität von der Audio-Engine mit dem Parameter PeriodInFrames an IAudioClient3::InitializeSharedAudioStream an. Der Wert von PeriodInFrames muss ein integrales Vielfaches des werts sein, der im pFundamentalPeriodInFrames-Parameter zurückgegeben wird. PeriodInFrames müssen auch größer oder gleich dem in pMinPeriodInFrames zurückgegebenen Wert und kleiner oder gleich dem Wert von pMaxPeriodInFrames sein.
Für ein 44100-kHz-Format gibt GetSharedModeEnginePeriod beispielsweise Folgendes zurück:
pDefaultPeriodInFrames = 448 Frames (ca. 10,16 Millisekunden)
pFundamentalPeriodInFrames = 4 Frames (ca. 0,09 Millisekunden)
pMinPeriodInFrames = 48 Frames (ca. 1,09 Millisekunden)
pMaxPeriodInFrames = 448 Frames (identisch mit der Standardeinstellung)
Zulässige Werte für den Parameter PeriodInFrames für InitializeSharedAudioStream wären 48 und 448. Sie würden auch Dinge wie 96 und 128 umfassen.
Sie enthalten NICHT 4 (was kleiner als der zulässige Mindestwert ist) oder 98 (was kein Vielfaches des Fundamentalwerts ist) oder 1000 (was größer als der maximal zulässige Wert ist).
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows 10 [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2016 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | audioclient.h |