Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions audiodecoder/current/com/rdk/hal/audiodecoder/IAudioDecoder.aidl
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,13 @@ import com.rdk.hal.PropertyValue;
* @author Luc Kennedy-Lamb
* @author Peter Stieglitz
* @author Douglas Adler
*
* <h3>Exception Handling</h3>
* Unless otherwise specified, this interface follows standard Android Binder semantics:
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
* The caller must ignore any output variables.
*/

@VintfStability
Expand All @@ -56,6 +63,8 @@ interface IAudioDecoder
* @exception binder::Status::Exception::EX_NONE for success.
*
* @returns Capabilities parcelable.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioDecoder}} for exception handling behavior).
*/
Capabilities getCapabilities();

Expand All @@ -71,6 +80,8 @@ interface IAudioDecoder
* @exception binder::Status::Exception::EX_NONE for success.
* @exception binder::Status::Exception::EX_ILLEGAL_ARGUMENT for invalid property value.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioDecoder}} for exception handling behavior).
*
*/
@nullable PropertyValue getProperty(in Property property);

Expand All @@ -81,6 +92,8 @@ interface IAudioDecoder
*
* @exception binder::Status::Exception::EX_NONE for success.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioDecoder}} for exception handling behavior).
*
* @see IAudioDecoderListener.onStateChanged().
*/
State getState();
Expand Down Expand Up @@ -113,6 +126,8 @@ interface IAudioDecoder
* @exception binder::Status::Exception::EX_NULL_POINTER for Null object.
*
* @returns IAudioDecoderController or null if the codec or secure is not supported if requested.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioDecoder}} for exception handling behavior).
*
* @pre The resource must be in State::CLOSED.
*
Expand All @@ -139,6 +154,8 @@ interface IAudioDecoder
* @exception binder::Status::Exception::EX_ILLEGAL_STATE If instance is not in OPENED State.
* @exception binder::Status::Exception::EX_NULL_POINTER for Null object.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioDecoder}} for exception handling behavior).
*
* @see open()
*/
boolean close(in IAudioDecoderController audioDecoderController);
Expand All @@ -158,6 +175,8 @@ interface IAudioDecoder
* @exception binder::Status::Exception::EX_NONE for success.
* @exception binder::Status::Exception::EX_NULL_POINTER for Null object.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioDecoder}} for exception handling behavior).
*
* @see unregisterEventListener()
*/
boolean registerEventListener(in IAudioDecoderEventListener audioDecoderEventListener);
Expand All @@ -174,6 +193,8 @@ interface IAudioDecoder
* @exception binder::Status::Exception::EX_NONE for success.
* @exception binder::Status::Exception::EX_NULL_POINTER for Null object.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioDecoder}} for exception handling behavior).
*
* @see registerEventListener()
*/
boolean unregisterEventListener(in IAudioDecoderEventListener audioDecoderEventListener);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ import com.rdk.hal.PropertyValue;
* @author Luc Kennedy-Lamb
* @author Peter Stieglitz
* @author Douglas Adler
*
* <h3>Exception Handling</h3>
* Unless otherwise specified, this interface follows standard Android Binder semantics:
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
* The caller must ignore any output variables.
*/

@VintfStability
Expand All @@ -46,6 +53,8 @@ interface IAudioDecoderController {
*
* @exception binder::Status::Exception::EX_NONE for success.
* @exception binder::Status::Exception::EX_ILLEGAL_ARGUMENT for invalid property and propertyValue.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioDecoderController}} for exception handling behavior).
*/
boolean setProperty(in Property property, in PropertyValue propertyValue);

Expand Down Expand Up @@ -102,6 +111,8 @@ interface IAudioDecoderController {
* @exception binder::Status::Exception::EX_NONE for success
* @exception binder::Status::Exception::EX_ILLEGAL_STATE
* @exception binder::Status::Exception::EX_ILLEGAL_ARGUMENT
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioDecoderController}} for exception handling behavior).
*
* @pre The resource must be in State::STARTED.
*/
Expand Down Expand Up @@ -179,6 +190,8 @@ interface IAudioDecoderController {
*
* @exception binder::Status::Exception::EX_NONE for success
* @exception binder::Status::Exception::EX_ILLEGAL_STATE
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioDecoderController}} for exception handling behavior).
* Thrown if the resource is not in State::STARTED.
*
* @pre The decoder resource must be in State::STARTED.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ import com.rdk.hal.audiodecoder.IAudioDecoder;
* @author Luc Kennedy-Lamb
* @author Peter Stieglitz
* @author Douglas Adler
*
* <h3>Exception Handling</h3>
* Unless otherwise specified, this interface follows standard Android Binder semantics:
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
* The caller must ignore any output variables.
*/

@VintfStability
Expand All @@ -43,6 +50,8 @@ interface IAudioDecoderManager
* @exception binder::Status::Exception::EX_NONE for success.
*
* @returns IAudioDecoder.Id[]
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioDecoderManager}} for exception handling behavior).
*/
IAudioDecoder.Id[] getAudioDecoderIds();

Expand All @@ -54,6 +63,8 @@ interface IAudioDecoderManager
* @exception binder::Status::Exception::EX_NONE for success.
*
* @returns IAudioDecoder which can be null if the resource index is invalid.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioDecoderManager}} for exception handling behavior).
*/
@nullable IAudioDecoder getAudioDecoder(in IAudioDecoder.Id decoderResourceId);
}
23 changes: 23 additions & 0 deletions audiosink/current/com/rdk/hal/audiosink/IAudioSink.aidl
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ import com.rdk.hal.State;
* @author Luc Kennedy-Lamb
* @author Peter Stieglitz
* @author Douglas Adler
*
* <h3>Exception Handling</h3>
* Unless otherwise specified, this interface follows standard Android Binder semantics:
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
* The caller must ignore any output variables.
*/

@VintfStability
Expand All @@ -56,6 +63,8 @@ interface IAudioSink
* @exception binder::Status::Exception::EX_NONE for success.
*
* @returns Capabilities parcelable.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSink}} for exception handling behavior).
*/
Capabilities getCapabilities();

Expand All @@ -69,6 +78,8 @@ interface IAudioSink
* @exception binder::Status::Exception::EX_NONE for success.
* @exception binder::Status::Exception::EX_ILLEGAL_ARGUMENT for invalid property value.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSink}} for exception handling behavior).
*
* @see setProperty()
*/
@nullable PropertyValue getProperty(in Property property);
Expand All @@ -83,6 +94,8 @@ interface IAudioSink
*
* @exception binder::Status::Exception::EX_NONE for success.
* @exception binder::Status::Exception::EX_ILLEGAL_ARGUMENT for invalid parameters.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSink}} for exception handling behavior).
*
* @see getProperty()
*/
Expand All @@ -94,6 +107,8 @@ interface IAudioSink
* @returns State enum value.
*
* @exception binder::Status::Exception::EX_NONE for success.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSink}} for exception handling behavior).
*
* @see IAudioSinkEventListener.onStateChanged().
*/
Expand All @@ -120,6 +135,8 @@ interface IAudioSink
* @exception binder::Status::Exception::EX_ILLEGAL_STATE If the resource is not in the CLOSED state.
* @exception binder::Status::Exception::EX_ILLEGAL_ARGUMENT for invalid parameters.
* @exception binder::Status::Exception::EX_NULL_POINTER for Null object.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSink}} for exception handling behavior).
*
* @pre The resource must be in the CLOSED state.
*
Expand All @@ -146,6 +163,8 @@ interface IAudioSink
* @exception binder::Status::Exception::EX_ILLEGAL_STATE If instance is not in OPENED State.
* @exception binder::Status::Exception::EX_NULL_POINTER for Null object.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSink}} for exception handling behavior).
*
* @see open()
*/
boolean close(in IAudioSinkController audioSinkController);
Expand All @@ -165,6 +184,8 @@ interface IAudioSink
* @exception binder::Status::Exception::EX_NONE for success.
* @exception binder::Status::Exception::EX_NULL_POINTER for Null object.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSink}} for exception handling behavior).
*
* @see unregisterEventListener()
*/
boolean registerEventListener(in IAudioSinkEventListener audioSinkEventListener);
Expand All @@ -181,6 +202,8 @@ interface IAudioSink
* @exception binder::Status::Exception::EX_NONE for success.
* @exception binder::Status::Exception::EX_NULL_POINTER for Null object.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSink}} for exception handling behavior).
*
* @see registerEventListener()
*/
boolean unregisterEventListener(in IAudioSinkEventListener audioSinkEventListener);
Expand Down
19 changes: 19 additions & 0 deletions audiosink/current/com/rdk/hal/audiosink/IAudioSinkController.aidl
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ import com.rdk.hal.audiodecoder.FrameMetadata;
* @author Luc Kennedy-Lamb
* @author Peter Stieglitz
* @author Douglas Adler
*
* <h3>Exception Handling</h3>
* Unless otherwise specified, this interface follows standard Android Binder semantics:
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
* The caller must ignore any output variables.
*/

@VintfStability
Expand All @@ -44,6 +51,8 @@ interface IAudioSinkController {
* @exception binder::Status::Exception::EX_ILLEGAL_STATE
*
* @returns boolean - true on success or false if the ID is invalid or not IAudioDecoder.Id.UNDEFINED.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSinkController}} for exception handling behavior).
*
* @pre The resource must be in State::READY.
*
Expand All @@ -58,6 +67,8 @@ interface IAudioSinkController {
*
* @exception binder::Status::Exception::EX_NONE for success
* @exception binder::Status::Exception::EX_ILLEGAL_STATE
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSinkController}} for exception handling behavior).
*
* @pre The resource must be in State::READY or State::STARTED.
*
Expand Down Expand Up @@ -118,6 +129,8 @@ interface IAudioSinkController {
* @exception binder::Status::Exception::EX_NONE for success
* @exception binder::Status::Exception::EX_ILLEGAL_STATE If the resource is not in the `STARTED` state or an audio frame is passed after EOS.
* @exception binder::Status::Exception::EX_ILLEGAL_ARGUMENT If an invalid argument is provided.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSinkController}} for exception handling behavior).
*
* @pre The resource must be in the `STARTED` state.
*/
Expand Down Expand Up @@ -146,6 +159,8 @@ interface IAudioSinkController {
*
* @exception binder::Status::Exception::EX_NONE for success
* @exception binder::Status::Exception::EX_ILLEGAL_STATE
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSinkController}} for exception handling behavior).
*
* @pre The resource must be in State::READY or State::STARTED.
*/
Expand All @@ -160,6 +175,8 @@ interface IAudioSinkController {
*
* @exception binder::Status::Exception::EX_NONE for success
* @exception binder::Status::Exception::EX_ILLEGAL_STATE
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSinkController}} for exception handling behavior).
*
* @pre The resource must be in State::READY or State::STARTED.
*/
Expand All @@ -186,6 +203,8 @@ interface IAudioSinkController {
*
* @exception binder::Status::Exception::EX_NONE for success
* @exception binder::Status::Exception::EX_ILLEGAL_STATE
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSinkController}} for exception handling behavior).
*
* @pre The resource must be in State::STARTED.
*/
Expand Down
13 changes: 13 additions & 0 deletions audiosink/current/com/rdk/hal/audiosink/IAudioSinkManager.aidl
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ import com.rdk.hal.audiosink.PlatformCapabilities;
* @author Luc Kennedy-Lamb
* @author Peter Stieglitz
* @author Douglas Adler
*
* <h3>Exception Handling</h3>
* Unless otherwise specified, this interface follows standard Android Binder semantics:
* - <b>Success</b>: The method returns `binder::Status::Exception::EX_NONE` and all output parameters/return values are valid.
* - <b>Failure (Exception)</b>: The method returns a service-specific exception (e.g., `EX_SERVICE_SPECIFIC`, `EX_ILLEGAL_ARGUMENT`).
* In this case, output parameters and return values contain undefined (garbage) memory and must not be used.
* The caller must ignore any output variables.
*/

@VintfStability
Expand All @@ -39,6 +46,8 @@ interface IAudioSinkManager
* @returns IAudioSink.Id[] array.
*
* @exception binder::Status::Exception::EX_NONE for success.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSinkManager}} for exception handling behavior).
*/
IAudioSink.Id[] getAudioSinkIds();

Expand All @@ -52,6 +61,8 @@ interface IAudioSinkManager
* @exception binder::Status::Exception::EX_NONE for success.
*
* @returns PlatformCapabilities parcelable.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSinkManager}} for exception handling behavior).
*/
PlatformCapabilities getPlatformCapabilities();

Expand All @@ -63,6 +74,8 @@ interface IAudioSinkManager
* @exception binder::Status::Exception::EX_NONE for success.
*
* @returns IAudioSink or null on invalid audio sink ID.
*
* @note On exception, output parameters/return values are undefined and must not be used. (See {{@link IAudioSinkManager}} for exception handling behavior).
*/
@nullable IAudioSink getAudioSink(in IAudioSink.Id audioSinkId);

Expand Down
Loading