Jump to main content

##

# 3.3.4.25 USB_HOST_AUDIO_V1_StreamEventHandlerSet Function

This function registers a client specific Audio v1.0 stream event handler. The Audio v1.0 Host Client Driver will call the appAudioHandler function specified as the second argument with relevant event and associated event data in response to audio stream data transfers that have been scheduled by the client.

## C

    USB_HOST_AUDIO_V1_RESULT USB_HOST_AUDIO_V1_StreamEventHandlerSet(
        USB_HOST_AUDIO_V1_STREAM_HANDLE handle,
        USB_HOST_AUDIO_V1_STREAM_EVENT_HANDLER appAudioHandler,
        uintptr_t context
    );

## Preconditions

None.

## Parameters

Parameters | Description
handle | The handle to the Audio v1.0 stream.
appAudioHandler | A pointer to event handler function. If NULL, events will not be generated.
context | The application specific context that is returned in the event handler.

## Returns

- USB_HOST_AUDIO_V1_RESULT_SUCCESS - The operation was successful
- USB_HOST_AUDIO_V1_RESULT_HANDLE_INVALID - The specified audio stream does not exist
- USB_HOST_AUDIO_V1_RESULT_FAILURE - An unknown failure occurred

## Remarks

None.