mediastreamer2 5.2.0
|
MSSndCard * ms_alsa_card_new_custom | ( | const char * | pcmdev, |
const char * | mixdev | ||
) |
Create a alsa card with user supplied pcm name and mixer name.
pcmdev | The pcm device name following alsa conventions (ex: plughw:0) |
mixdev | The mixer device name following alsa conventions. |
Returns: a MSSndCard object, NULL if alsa support is not available.
void ms_alsa_card_set_forced_sample_rate | ( | int | samplerate | ) |
Use supplied sample rate to open alsa devices (forced rate). Has no interest except workarouding driver bugs. Use -1 to revert to normal behavior.
void ms_snd_card_app_notifies_activation | ( | MSSndCard * | obj, |
bool_t | yesno | ||
) |
Used by application to tell the MSSndCard if rely on notifications of activation of audio session. When yesno is set to FALSE, the MSSndCard will not rely on notifications of activation of audio session, and will assume that audio is always usable. If set to TRUE, the mediastreamer2 will require explicit calls to ms_snd_card_notify_audio_session_activated().
obj | A sound card object. |
yesno | TRUE if app notifies is activated, FALSE otherwise. The default value is FALSE. |
void ms_snd_card_configure_audio_session | ( | MSSndCard * | obj | ) |
Used to configure audio session with default settings. Callkit usage.
obj | A sound card object. |
Create an INPUT filter based on the selected sound card.
obj | A sound card object. |
Returns: A MSFilter if successfull, NULL otherwise.
Create an OUPUT filter based on the selected sound card.
obj | A sound card object. |
Returns: A MSFilter if successfull, NULL otherwise.
void ms_snd_card_destroy | ( | MSSndCard * | obj | ) |
Destroy sound card object.
obj | A MSSndCard object. |
const char * ms_snd_card_device_type_to_string | ( | const MSSndCardDeviceType | type | ) |
Retreive a sound card's device type string.
type | A sound card type. |
Returns: a string if successfull, "bad type" otherwise.
Returns a string value of the given MSSndCardDeviceType enum
Duplicate a sound card object.
This helps to open several time a sound card.
card | A sound card object. |
Returns: MSSndCard if successfull, NULL otherwise.
Returns TRUE if both MSSndCard are equal, which means that they refer to the same audio device with same capabilities.
unsigned int ms_snd_card_get_capabilities | ( | const MSSndCard * | obj | ) |
Retreive sound card's capabilities.
MS_SND_CARD_CAP_CAPTURE MS_SND_CARD_CAP_PLAYBACK MS_SND_CARD_CAP_CAPTURE|MS_SND_CARD_CAP_PLAYBACK MS_SND_CARD_CAP_BUILTIN_ECHO_CANCELLER
obj | A sound card object. |
Returns: A unsigned int if successfull, 0 otherwise.
int ms_snd_card_get_control | ( | MSSndCard * | obj, |
MSSndCardControlElem | e | ||
) |
Get some mixer control.
MS_SND_CARD_MASTER_MUTE, -> return 0: unmute, 1: mute MS_SND_CARD_PLAYBACK_MUTE, -> return 0: unmute, 1: mute MS_SND_CARD_CAPTURE_MUTE -> return 0: unmute, 1: mute
Note: not implemented on all sound card filters.
obj | A sound card object. |
e | A sound card mixer object. |
Returns: A int if successfull, <0 otherwise.
MSSndCardDeviceType ms_snd_card_get_device_type | ( | const MSSndCard * | obj | ) |
Retreive a sound card's device type.
obj | A sound card object. |
Returns: an MSSndCardDeviceType enum type. Default value is MSSndCardDeviceType::MS_SND_CARD_DEVICE_TYPE_UNKNOWN.
const char * ms_snd_card_get_driver_type | ( | const MSSndCard * | obj | ) |
Retreive a sound card's driver type string.
Internal driver types are either: "OSS, ALSA, WINSND, PASND, CA"
obj | A sound card object. |
Returns: a string if successfull, NULL otherwise.
int ms_snd_card_get_internal_id | ( | MSSndCard * | obj | ) |
Retrieve sound card's internal ID.
obj | A sound card object. |
Returns: An integer storing the internal ID value.
int ms_snd_card_get_level | ( | MSSndCard * | obj, |
MSSndCardMixerElem | e | ||
) |
Get some mixer level value.
MS_SND_CARD_MASTER, MS_SND_CARD_PLAYBACK, MS_SND_CARD_CAPTURE
Note: not implemented on all sound card filters.
obj | A sound card object. |
e | A sound card mixer object. |
Returns: A int if successfull, <0 otherwise.
int ms_snd_card_get_minimal_latency | ( | MSSndCard * | obj | ) |
Returns the sound card minimal latency (playback+record), in milliseconds. This value is to be used by the software echo cancellers to know where to search for the echo (optimization). Typically, an echo shall not be found before the value returned by this function. If this value is not known, then it should return 0.
obj | A sound card object. |
const char * ms_snd_card_get_name | ( | const MSSndCard * | obj | ) |
Retreive a sound card's name.
obj | A sound card object. |
Returns: a string if successfull, NULL otherwise.
int ms_snd_card_get_preferred_sample_rate | ( | const MSSndCard * | obj | ) |
Get preferred sample rate
obj | A sound card object. |
Returns: return sample rate in khz
MSSndCardStreamType ms_snd_card_get_stream_type | ( | MSSndCard * | obj | ) |
Gets the stream type for this soundcard, default is VOICE
const char * ms_snd_card_get_string_id | ( | const MSSndCard * | obj | ) |
Retreive sound card's name ($driver_type: $name).
obj | A sound card object. |
Returns: A string if successfull, NULL otherwise.
MSSndCard * ms_snd_card_new | ( | MSSndCardDesc * | desc | ) |
Create a new sound card object.
desc | A sound card description object. |
Returns: MSSndCard if successfull, NULL otherwise.
MSSndCard * ms_snd_card_new_with_name | ( | MSSndCardDesc * | desc, |
const char * | name | ||
) |
Create a new sound card object.
desc | A sound card description object. |
name | The card name |
Returns: MSSndCard if successfull, NULL otherwise.
void ms_snd_card_notify_audio_route_changed | ( | MSSndCard * | obj | ) |
Used by application to notify whether audio route is changed. On most platform this function is useless. But an iOS application needs to explicitely notify mediastreamer2 with ms_snd_card_notify_audio_route_changed() about the changment of audio route to ajust the sample rate for playback/record.
obj | A sound card object. |
void ms_snd_card_notify_audio_session_activated | ( | MSSndCard * | obj, |
bool_t | activated | ||
) |
Used by application to notify whether audio access is allowed for the process. On most platform this function is useless, but in an iOS application using Callkit, the system decides when audio (through the AVAudioSession singleton) is open or closed. Such application needs to explicitely notify mediastreamer2 with ms_snd_card_notify_audio_session_activated() about the state of the audio session.
obj | A sound card object. |
actived | TRUE if audio session is activated, FALSE otherwise. |
void ms_snd_card_set_capture | ( | MSSndCard * | obj, |
MSSndCardCapture | c | ||
) |
Set some source for capture.
MS_SND_CARD_MIC, MS_SND_CARD_LINE
Note: not implemented on all sound card filters.
obj | A sound card object. |
c | A sound card capture value. |
Returns: A int if successfull, 0 otherwise.
int ms_snd_card_set_control | ( | MSSndCard * | obj, |
MSSndCardControlElem | e, | ||
int | val | ||
) |
Set some mixer control.
MS_SND_CARD_MASTER_MUTE, -> 0: unmute, 1: mute MS_SND_CARD_PLAYBACK_MUTE, -> 0: unmute, 1: mute MS_SND_CARD_CAPTURE_MUTE -> 0: unmute, 1: mute
Note: not implemented on all sound card filters.
obj | A sound card object. |
e | A sound card control object. |
val | A value for control. |
Returns: 0 if successfull, <0 otherwise.
void ms_snd_card_set_internal_id | ( | MSSndCard * | obj, |
int | id | ||
) |
Set internal ID of the sound card.
obj | A sound card object. |
id | A sound card internal ID. |
void ms_snd_card_set_level | ( | MSSndCard * | obj, |
MSSndCardMixerElem | e, | ||
int | percent | ||
) |
Set some mixer level value.
MS_SND_CARD_MASTER, MS_SND_CARD_PLAYBACK, MS_SND_CARD_CAPTURE
Note: not implemented on all sound card filters.
obj | A sound card object. |
e | A sound card mixer object. |
percent | A volume level. |
int ms_snd_card_set_preferred_sample_rate | ( | MSSndCard * | obj, |
int | rate | ||
) |
set preferred sample rate. The underlying card will try to avoid any resampling for this samplerate.
obj | A sound card object. |
rate | sampling rate. |
Returns: 0 if successfull, <0 otherwise.
void ms_snd_card_set_stream_type | ( | MSSndCard * | obj, |
MSSndCardStreamType | type | ||
) |
Sets the stream type for this soundcard, default is VOICE
void ms_snd_card_set_usage_hint | ( | MSSndCard * | obj, |
bool_t | is_going_to_be_used | ||
) |
Enable application to tell that the soundcard is going to be used or will cease to be used. This is recommended for cards which are known to be slow (see flag MS_SND_CARD_CAP_IS_SLOW ).
void ms_snd_card_unref | ( | MSSndCard * | sndCard | ) |
Removes a ref from a MSSndCard