summaryrefslogtreecommitdiff
path: root/legacy/emotion/src/lib/Emotion.h
diff options
context:
space:
mode:
authorRafael Antognolli <antognolli@gmail.com>2011-06-30 20:02:12 +0000
committerRafael Antognolli <antognolli@gmail.com>2011-06-30 20:02:12 +0000
commit4c434a15d367ff02765dadcbc27fc72d7e0020c2 (patch)
treea64cc88ec72d6112ad73bfbca2dd1aff097e8e9a /legacy/emotion/src/lib/Emotion.h
parentdd72eeea0e299f66d5a260185032233f181bce18 (diff)
emotion/doc - Document some audio functions.
- emotion_object_audio_volume_set - emotion_object_audio_volume_get - emotion_object_audio_mute_set - emotion_object_audio_mute_get SVN revision: 60884
Diffstat (limited to '')
-rw-r--r--legacy/emotion/src/lib/Emotion.h64
1 files changed, 64 insertions, 0 deletions
diff --git a/legacy/emotion/src/lib/Emotion.h b/legacy/emotion/src/lib/Emotion.h
index b13b8ea21a..a9fd1d7266 100644
--- a/legacy/emotion/src/lib/Emotion.h
+++ b/legacy/emotion/src/lib/Emotion.h
@@ -282,9 +282,73 @@ EAPI void emotion_object_smooth_scale_set (Evas_Object *obj, Eina_B
282EAPI Eina_Bool emotion_object_smooth_scale_get (const Evas_Object *obj); 282EAPI Eina_Bool emotion_object_smooth_scale_get (const Evas_Object *obj);
283EAPI double emotion_object_ratio_get (const Evas_Object *obj); 283EAPI double emotion_object_ratio_get (const Evas_Object *obj);
284EAPI void emotion_object_event_simple_send (Evas_Object *obj, Emotion_Event ev); 284EAPI void emotion_object_event_simple_send (Evas_Object *obj, Emotion_Event ev);
285
286/**
287 * @brief Set the audio volume.
288 *
289 * @param obj The object where the volume is being set.
290 * @param vol The new volume parameter. Range is from 0.0 to 1.0.
291 *
292 * Sets the audio volume of the stream being played. This has nothing to do with
293 * the system volume. This volume will be multiplied by the system volume. e.g.:
294 * if the current volume level is 0.5, and the system volume is 50%, it will be
295 * 0.5 * 0.5 = 0.25.
296 *
297 * The default value depends on the module used. This value doesn't get changed
298 * when another file is loaded.
299 *
300 * @see emotion_object_audio_volume_get()
301 *
302 * @ingroup Emotion_Audio
303 */
285EAPI void emotion_object_audio_volume_set (Evas_Object *obj, double vol); 304EAPI void emotion_object_audio_volume_set (Evas_Object *obj, double vol);
305
306/**
307 * @brief Get the audio volume.
308 *
309 * @param obj The object from which we are retrieving the volume.
310 * @return The current audio volume level for this object.
311 *
312 * Get the current value for the audio volume level. Range is from 0.0 to 1.0.
313 * This volume is set with emotion_object_audio_volume_set().
314 *
315 * @see emotion_object_audio_volume_set()
316 *
317 * @ingroup Emotion_Audio
318 */
286EAPI double emotion_object_audio_volume_get (const Evas_Object *obj); 319EAPI double emotion_object_audio_volume_get (const Evas_Object *obj);
320
321/**
322 * @brief Set the mute audio option for this object.
323 *
324 * @param obj The object which we are setting the mute audio option.
325 * @param mute Whether the audio should be muted (@c EINA_TRUE) or not (@c
326 * EINA_FALSE).
327 *
328 * This function sets the mute audio option for this emotion object. The current
329 * module used for this object can use this to avoid decoding the audio portion
330 * of the loaded media file.
331 *
332 * @see emotion_object_audio_mute_get()
333 * @see emotion_object_video_mute_set()
334 *
335 * @ingroup Emotion_Audio
336 */
287EAPI void emotion_object_audio_mute_set (Evas_Object *obj, Eina_Bool mute); 337EAPI void emotion_object_audio_mute_set (Evas_Object *obj, Eina_Bool mute);
338
339/**
340 * @brief Get the mute audio option of this object.
341 *
342 * @param obj The object which we are retrieving the mute audio option from.
343 * @return Whether the audio is muted (@c EINA_TRUE) or not (@c EINA_FALSE).
344 *
345 * This function return the mute audio option from this emotion object. It can
346 * be set with emotion_object_audio_mute_set().
347 *
348 * @see emotion_object_audio_mute_set()
349 *
350 * @ingroup Emotion_Audio
351 */
288EAPI Eina_Bool emotion_object_audio_mute_get (const Evas_Object *obj); 352EAPI Eina_Bool emotion_object_audio_mute_get (const Evas_Object *obj);
289EAPI int emotion_object_audio_channel_count (const Evas_Object *obj); 353EAPI int emotion_object_audio_channel_count (const Evas_Object *obj);
290EAPI const char *emotion_object_audio_channel_name_get(const Evas_Object *obj, int channel); 354EAPI const char *emotion_object_audio_channel_name_get(const Evas_Object *obj, int channel);