-
- All Implemented Interfaces:
-
app.rive.AssetOps
public class AudioAsset.Companion implements AssetOps<AudioHandle, AudioAsset>
-
-
Method Summary
Modifier and Type Method Description final Result<AudioAsset>fromBytes(CommandQueue riveWorker, ByteArray bytes)Create and decode an audio asset from the given byte array on the provided Rive worker. AudioHandledecode(CommandQueue worker, ByteArray bytes)Decode the asset from the given byte array on the provided Rive worker. Unitdelete(CommandQueue worker, AudioHandle handle)Delete the asset from the provided Rive worker. Unitregister(CommandQueue worker, String key, AudioHandle handle)Register the asset with the provided Rive worker under the given key. Unitunregister(CommandQueue worker, String key)Unregister the asset from the provided Rive worker for the given key. AudioAssetconstruct(AudioHandle handle, CommandQueue worker)Construct the asset instance from the given handle, key, and Rive worker. StringgetTag()The tag used for logging purposes. StringgetLabel()A label for the asset type, used in logging. -
-
Method Detail
-
fromBytes
final Result<AudioAsset> fromBytes(CommandQueue riveWorker, ByteArray bytes)
Create and decode an audio asset from the given byte array on the provided Rive worker.
The audio can only be used on the same RiveWorker it was created on.
Must be registered with AudioAsset.register to be used for referenced audio.
⚠️ The lifetime of the returned audio is managed by the caller. Make sure to call close when you are done with it to release its resources.
- Parameters:
riveWorker- The Rive worker that owns the audio.bytes- The byte array containing the audio data to decode.
-
decode
AudioHandle decode(CommandQueue worker, ByteArray bytes)
Decode the asset from the given byte array on the provided Rive worker.
-
delete
Unit delete(CommandQueue worker, AudioHandle handle)
Delete the asset from the provided Rive worker.
-
register
Unit register(CommandQueue worker, String key, AudioHandle handle)
Register the asset with the provided Rive worker under the given key.
-
unregister
Unit unregister(CommandQueue worker, String key)
Unregister the asset from the provided Rive worker for the given key.
-
construct
AudioAsset construct(AudioHandle handle, CommandQueue worker)
Construct the asset instance from the given handle, key, and Rive worker.
-
-
-
-