Метод ISpatialAudioObjectBase::IsActive (spatialaudioclient.h)

Возвращает логическое значение, указывающее, является ли ISpatialAudioObject допустимым.

Синтаксис

HRESULT IsActive(
  [out] BOOL *isActive
);

Параметры

[out] isActive

ЗНАЧЕНИЕ TRUE , если звуковой объект в данный момент действителен; в противном случае — FALSE.

Возвращаемое значение

Если метод завершается успешно, возвращает значение S_OK.

Комментарии

Если это значение равно false, необходимо вызвать Метод Release , чтобы в будущем сделать ресурс звукового объекта доступным.

IsActive будет иметь значение false после неявного или явного вызова SetEndOfStream . SetEndOfStream вызывается системой неявно, если GetBuffer не вызывается в пределах прохода обработки звука (между вызовами ISpatialAudioObjectRenderStream::BeginUpdatingAudioObjects и ISpatialAudioObjectRenderStream::EndUpdatingAudioObjects).

Модуль отрисовки также отключит звуковой объект, установив для параметра IsActive значение false, когда ресурсы звуковых объектов станут недоступными. В этом случае перед отключением объекта отправляется уведомление через ISpatialAudioObjectRenderStreamNotify . Значение, возвращаемое параметром availableDynamicObjectCount для ISpatialAudioObjectRenderStream::BeginUpdatingAudioObjects , указывает, сколько объектов будет обработано для каждого прохода.

Требования

Требование	Значение
Целевая платформа	Windows
Header	spatialaudioclient.h

См. также раздел

ISpatialAudioObject

ISpatialAudioObjectBase