Método IAudioSessionControl::SetIconPath (audiopolicy.h)

  • Artículo

El método SetIconPath asigna un icono de presentación a la sesión actual.

Sintaxis

HRESULT SetIconPath(
  [in] LPCWSTR Value,
  [in] LPCGUID EventContext
);

Parámetros

[in] Value

Puntero a una cadena de caracteres anchos terminada en null que especifica la ruta de acceso y el nombre de archivo de un archivo .ico, .dll o .exe archivo que contiene el icono. Para obtener información sobre las rutas de acceso de icono, consulte la documentación de Windows SDK.

[in] EventContext

Puntero al GUID de contexto de evento. Si una llamada a este método genera un evento de cambio de icono, el administrador de sesiones envía notificaciones a todos los clientes que han registrado interfaces IAudioSessionEvents con el administrador de sesiones. El administrador de sesiones incluye el valor del puntero EventContext con cada notificación. Tras recibir una notificación, un cliente puede determinar si es o no el origen del evento inspeccionando el valor eventContext . Este esquema depende del cliente que seleccione un valor para este parámetro que sea único entre todos los clientes de la sesión. Si el autor de la llamada proporciona un puntero NULL para este parámetro, el método de notificación del cliente recibe un puntero de contexto NULL .

Valor devuelto

Si el método se realiza correctamente, devuelve S_OK. Si se produce un error, los códigos de retorno posibles incluyen, entre otros, los valores que se muestran en la tabla siguiente.

Código devuelto Descripción
E_POINTER
 El valor del parámetro es NULL.
AUDCLNT_E_DEVICE_INVALIDATED
 El dispositivo de punto de conexión de audio se ha desconectado o el hardware de audio o los recursos de hardware asociados se han reconfigurado, deshabilitado, quitado o dejado de estar disponible para su uso.
AUDCLNT_E_SERVICE_NOT_RUNNING
 El servicio de audio de Windows no se está ejecutando.

Comentarios

En Windows Vista, el programa proporcionado por el sistema, Sndvol.exe, usa el icono de presentación (junto con el nombre para mostrar) para etiquetar el control de volumen de la sesión. Si el cliente no llama a SetIconPath para asignar un icono a la sesión, el programa Sndvol usa el icono de la ventana de la aplicación como el icono predeterminado para la sesión.

En el caso de una sesión entre procesos, la sesión no está asociada a un único proceso de aplicación. Por lo tanto, Sndvol no tiene ningún icono específico de la aplicación para usarlo de forma predeterminada y el cliente debe llamar a SetIconPath para evitar mostrar un icono sin sentido.

El icono de presentación no persiste más allá de la duración del objeto IAudioSessionControl . Por lo tanto, una vez publicadas todas las referencias al objeto, una versión creada posteriormente del objeto (con la misma aplicación, el mismo GUID de sesión y el mismo dispositivo de punto de conexión) volverá a tener un icono predeterminado hasta que el cliente llame a SetIconPath.

El cliente puede recuperar el icono de presentación de la sesión llamando al método IAudioSessionControl::GetIconPath .

Requisitos

   
Cliente mínimo compatible Windows Vista [aplicaciones de escritorio | aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2008 [aplicaciones de escritorio | aplicaciones para UWP]
Plataforma de destino Windows
Encabezado audiopolicy.h

Consulte también

IAudioSessionControl (Interfaz)

IAudioSessionControl::GetIconPath