Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
M
miniaudio
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Packages
Packages
List
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issues
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
MyCard
miniaudio
Commits
32da9fe5
Commit
32da9fe5
authored
Oct 28, 2017
by
David Reid
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Simplify some documentation for clarity.
parent
400e3c9a
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
5 additions
and
25 deletions
+5
-25
mini_al.h
mini_al.h
+5
-25
No files found.
mini_al.h
View file @
32da9fe5
...
@@ -914,11 +914,7 @@ mal_result mal_context_uninit(mal_context* pContext);
...
@@ -914,11 +914,7 @@ mal_result mal_context_uninit(mal_context* pContext);
// Some backends and platforms may only support default playback and capture devices.
// Some backends and platforms may only support default playback and capture devices.
//
//
// Return Value:
// Return Value:
// - MAL_SUCCESS if successful.
// MAL_SUCCESS if successful; any other error code otherwise.
// - MAL_INVALID_ARGS
// One or more of the input arguments is invalid.
// - MAL_NO_BACKEND
// There is no supported backend, or there was an error loading it (such as a missing dll/so).
//
//
// Thread Safety: SAFE, SEE NOTES.
// Thread Safety: SAFE, SEE NOTES.
// This API uses an application-defined buffer for output. This is thread-safe so long as the
// This API uses an application-defined buffer for output. This is thread-safe so long as the
...
@@ -954,19 +950,7 @@ mal_result mal_enumerate_devices(mal_context* pContext, mal_device_type type, ma
...
@@ -954,19 +950,7 @@ mal_result mal_enumerate_devices(mal_context* pContext, mal_device_type type, ma
// to the official documentation for ActivateAudioInterfaceAsync() for more information.
// to the official documentation for ActivateAudioInterfaceAsync() for more information.
//
//
// Return Value:
// Return Value:
// - MAL_SUCCESS if successful.
// MAL_SUCCESS if successful; any other error code otherwise.
// - MAL_INVALID_ARGS
// One or more of the input arguments is invalid.
// - MAL_NO_BACKEND
// There is no supported backend, or there was an error loading it (such as a missing dll/so).
// - MAL_OUT_OF_MEMORY
// A necessary memory allocation failed, likely due to running out of memory.
// - MAL_FORMAT_NOT_SUPPORTED
// The specified format is not supported by the backend. mini_al does not currently do any
// software format conversions which means initialization must fail if the backend does not
// natively support it.
// - MAL_FAILED_TO_INIT_BACKEND
// There was a backend-specific error during initialization.
//
//
// Thread Safety: UNSAFE
// Thread Safety: UNSAFE
// It is not safe to call this function simultaneously for different devices because some backends
// It is not safe to call this function simultaneously for different devices because some backends
...
@@ -985,11 +969,7 @@ mal_result mal_device_init(mal_context* pContext, mal_device_type type, mal_devi
...
@@ -985,11 +969,7 @@ mal_result mal_device_init(mal_context* pContext, mal_device_type type, mal_devi
// harmless if you do.
// harmless if you do.
//
//
// Return Value:
// Return Value:
// - MAL_SUCCESS if successful.
// MAL_SUCCESS if successful; any other error code otherwise.
// - MAL_INVALID_ARGS
// pDevice is NULL.
// - MAL_DEVICE_NOT_INITIALIZED
// The device is not currently or was never initialized.
//
//
// Thread Safety: UNSAFE
// Thread Safety: UNSAFE
// As soon as this API is called the device should be considered undefined. All bets are off if you
// As soon as this API is called the device should be considered undefined. All bets are off if you
...
@@ -1039,7 +1019,7 @@ void mal_device_set_stop_callback(mal_device* pDevice, mal_stop_proc proc);
...
@@ -1039,7 +1019,7 @@ void mal_device_set_stop_callback(mal_device* pDevice, mal_stop_proc proc);
// to be done _before_ the device begins playback.
// to be done _before_ the device begins playback.
//
//
// Return Value:
// Return Value:
// - MAL_SUCCESS if successful.
// - MAL_SUCCESS if successful
; any other error code otherwise
.
// - MAL_INVALID_ARGS
// - MAL_INVALID_ARGS
// One or more of the input arguments is invalid.
// One or more of the input arguments is invalid.
// - MAL_DEVICE_NOT_INITIALIZED
// - MAL_DEVICE_NOT_INITIALIZED
...
@@ -1070,7 +1050,7 @@ mal_result mal_device_start(mal_device* pDevice);
...
@@ -1070,7 +1050,7 @@ mal_result mal_device_start(mal_device* pDevice);
// Puts the device to sleep, but does not uninitialize it. Use mal_device_start() to start it up again.
// Puts the device to sleep, but does not uninitialize it. Use mal_device_start() to start it up again.
//
//
// Return Value:
// Return Value:
// - MAL_SUCCESS if successful.
// - MAL_SUCCESS if successful
; any other error code otherwise
.
// - MAL_INVALID_ARGS
// - MAL_INVALID_ARGS
// One or more of the input arguments is invalid.
// One or more of the input arguments is invalid.
// - MAL_DEVICE_NOT_INITIALIZED
// - MAL_DEVICE_NOT_INITIALIZED
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment