diff options
| author | Daniel Caujolle-Bert <f1rmb@users.sourceforge.net> | 2001-10-05 13:41:53 +0000 |
|---|---|---|
| committer | Daniel Caujolle-Bert <f1rmb@users.sourceforge.net> | 2001-10-05 13:41:53 +0000 |
| commit | 2f0db17cc0d942fffa715d8d686721ce557f307c (patch) | |
| tree | e74ac91464cb37ed0e0ca0accd91a1e81d88af66 /doc/man/en/man3/audio_prop.3 | |
| parent | 6f6fbbc03f116bde9ab3ae33a7d25b7991017e70 (diff) | |
| download | xine-lib-2f0db17cc0d942fffa715d8d686721ce557f307c.tar.gz xine-lib-2f0db17cc0d942fffa715d8d686721ce557f307c.tar.bz2 | |
Fixed $DESTDIR, use it for rpms generation. Update xine.h for audio cap/props.
CVS patchset: 738
CVS date: 2001/10/05 13:41:53
Diffstat (limited to 'doc/man/en/man3/audio_prop.3')
| -rw-r--r-- | doc/man/en/man3/audio_prop.3 | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/doc/man/en/man3/audio_prop.3 b/doc/man/en/man3/audio_prop.3 new file mode 100644 index 000000000..3216fc780 --- /dev/null +++ b/doc/man/en/man3/audio_prop.3 @@ -0,0 +1,115 @@ +.TH "Constants for the get/set properties functions." 3 "5 Oct 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Constants for the get/set properties functions. \- +.SS "Defines" + +.in +1c +.ti -1c +.RI "#define \fBAO_PROP_MIXER_VOL\fP 0" +.br +.ti -1c +.RI "#define \fBAO_PROP_PCM_VOL\fP 1" +.br +.ti -1c +.RI "#define \fBAO_PROP_MUTE_VOL\fP 2" +.br +.in -1c +.SS "Functions" + +.in +1c +.ti -1c +.RI "int \fBxine_get_audio_property\fP (\fBxine_t\fP *self, int property)" +.br +.RI "\fIGet audio driver property.\fP" +.ti -1c +.RI "int \fBxine_set_audio_property\fP (\fBxine_t\fP *self, int property, int value)" +.br +.RI "\fISet audio driver property value.\fP" +.in -1c +.SH "DEFINE DOCUMENTATION" +.PP +.SS "#define AO_PROP_MIXER_VOL 0" +.PP +Mixer volume property. +.PP +\fBSee also: \fP +.in +1c +\fBxine_get_audio_property\fP(), \fBxine_set_audio_property\fP() +.SS "#define AO_PROP_MUTE_VOL 2" +.PP +Pcm volume property. +.PP +\fBSee also: \fP +.in +1c +\fBxine_get_audio_property\fP(), \fBxine_set_audio_property\fP() +.SS "#define AO_PROP_PCM_VOL 1" +.PP +Pcm volume property. +.PP +\fBSee also: \fP +.in +1c +\fBxine_get_audio_property\fP(), \fBxine_set_audio_property\fP() +.SH "FUNCTION DOCUMENTATION" +.PP +.SS "int xine_get_audio_property (\fBxine_t\fP * self, int property)" +.PP +Get audio driver property. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.TP +\fB\fIproperty\fP\fP +( see AO_PROP_* ) +.PP +\fBReturns: \fP +.in +1c +value of property. +.PP +Get audio property ( AO_PROP_* ) value . +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.TP +\fB\fIproperty\fP\fP + +.SS "int xine_set_audio_property (\fBxine_t\fP * self, int property, int value)" +.PP +Set audio driver property value. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP +Current xine engine configuration ( see \fBxine_init\fP() ) +.TP +\fB\fIproperty\fP\fP +( see AO_PROP_* ) +.TP +\fB\fIvalue\fP\fP +of property +.PP +\fBReturns: \fP +.in +1c +value on success, otherwise ~value. +.PP +Set audio property value ( AO_PROP_* ). It will return value if operation is successfuly completed, and ~value on failure. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fIself\fP\fP + +.TP +\fB\fIproperty\fP\fP + +.TP +\fB\fIvalue\fP\fP +
\ No newline at end of file |