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
2dd522b6
Commit
2dd522b6
authored
Jan 13, 2019
by
David Reid
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update documentation for mal_device_init().
parent
4d03928b
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
4 additions
and
5 deletions
+4
-5
mini_al.h
mini_al.h
+4
-5
No files found.
mini_al.h
View file @
2dd522b6
...
@@ -2316,11 +2316,6 @@ mal_result mal_context_get_device_info(mal_context* pContext, mal_device_type de
...
@@ -2316,11 +2316,6 @@ mal_result mal_context_get_device_info(mal_context* pContext, mal_device_type de
// however, use null when initializing the first device, and then use device.pContext for the
// however, use null when initializing the first device, and then use device.pContext for the
// initialization of other devices.
// initialization of other devices.
//
//
// The device ID (pDeviceID) can be null, in which case the default device is used. Otherwise, you
// can retrieve the ID by calling mal_context_get_devices() and using the ID from the returned data.
// Set pDeviceID to NULL to use the default device. Do _not_ rely on the first device ID returned
// by mal_context_enumerate_devices() or mal_context_get_devices() to be the default device.
//
// The device's configuration is controlled with pConfig. This allows you to configure the sample
// The device's configuration is controlled with pConfig. This allows you to configure the sample
// format, channel count, sample rate, etc. Before calling mal_device_init(), you will need to
// format, channel count, sample rate, etc. Before calling mal_device_init(), you will need to
// initialize a mal_device_config object using mal_device_config_init(), mal_device_config_init_playback(),
// initialize a mal_device_config object using mal_device_config_init(), mal_device_config_init_playback(),
...
@@ -2348,6 +2343,10 @@ mal_result mal_context_get_device_info(mal_context* pContext, mal_device_type de
...
@@ -2348,6 +2343,10 @@ mal_result mal_context_get_device_info(mal_context* pContext, mal_device_type de
// the backend. If you pass in NULL for pConfig or 0 for the sample format, channel count,
// the backend. If you pass in NULL for pConfig or 0 for the sample format, channel count,
// sample rate _and_ channel map, data transmission will run on an optimized pass-through fast path.
// sample rate _and_ channel map, data transmission will run on an optimized pass-through fast path.
//
//
// The buffer size should be treated as a hint. mini_al will try it's best to use exactly what you
// ask for, but it may differ. You should not assume the number of frames specified in each call to
// the data callback is exactly what you originally specified.
//
// The <periods> property controls how frequently the background thread is woken to check for more
// The <periods> property controls how frequently the background thread is woken to check for more
// data. It's tied to the buffer size, so as an example, if your buffer size is equivalent to 10
// data. It's tied to the buffer size, so as an example, if your buffer size is equivalent to 10
// milliseconds and you have 2 periods, the CPU will wake up approximately every 5 milliseconds.
// milliseconds and you have 2 periods, the CPU will wake up approximately every 5 milliseconds.
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