← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/oss4/oneiric-proposed

« back to all changes in this revision

Viewing changes to misc/man9ossddk/ossddk_adev_set_songname.9ossddk

  • Committer: Bazaar Package Importer
  • Author(s): Stefano Rivera
  • Date: 2011-06-16 20:37:48 UTC
  • mfrom: (5.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20110616203748-jbrxik6ql33z54co
Tags: 4.2-build2004-1ubuntu1
https://launchpad.net/bugs/746048
https://launchpad.net/bugs/770972
* Merge from Debian unstable.
  - Supports our current kernel (LP: #746048)
  Remaining changes:
  - debian/oss4-dkms.dkms.in: s/source/build/ in Kernel headers paths.
* ld-as-needed.patch: Re-order CC arguments to enable building with ld
  --as-needed (LP: #770972)

Show diffs side-by-side

added added

removed removed

Lines of Context:
misc/man9ossddk/ossddk_adev_set_songname.9ossddk
 
1
'\" te
 
2
.\"  Copyright (c) 2005, 4Front Technologies 2005\&.
 
3
.TH ossddk_adev_set_songname 9ossddk "12 Sep 2005" "SunOS 5.10" "OSS DDK Services"
 
4
.SH "NAME"
 
5
ossddk_adev_set_songname \- Assign song name to an audio stream
 
6
.PP
 
7
.SH "SYNOPSIS"
 
8
.nf
 
9
#include <sys/soundcard.h>
 
10
.LP
 
11
#include <sys/ossddk/ossddk.h>
 
12
.fi
 
13
.LP
 
14
\fBvoid\fR ossddk_adev_set_songname(\fBint \fIdev\fP, \fBchar *\fIsong\fP);
 
15
.PP
 
16
.SH "INTERFACE LEVEL"
 
17
.PP
 
18
Open Sound System specific (OSS 4.0 DDK)\&.
 
19
.PP
 
20
.SH "ARGUMENTS"
 
21
.PP
 
22
.sp
 
23
.ne 2
 
24
.mk
 
25
\fB\fIdev\fR
 
26
.in +16n
 
27
.rt
 
28
OSS audio device number.
 
29
.in -16n
 
30
.sp
 
31
.ne 2
 
32
.mk
 
33
\fB\fIsong\fR
 
34
.in +16n
 
35
.rt
 
36
Pointer to a string containing 0 to 63 characters. An empty string means that
 
37
there is no song name information available. The string should only contain printable
 
38
(8 bit ISO-8859-x) characters.
 
39
.in -16n
 
40
.PP
 
41
.SH "DESCRIPTION"
 
42
.PP
 
43
Song name is free formatted string describing the content of the audio stream. Source 
 
44
of the stream (for example the driver of an input device) can assign the name. The
 
45
application recording from the device can obtain the name using 
 
46
\fISNDCTL_AUDIOINFO(2oss)\fR. For example a driver of an RDS radio receiver can
 
47
obtain the song name from the RDS information sent by the radio station.
 
48
.PP
 
49
The song name string can contain any other information about the stream if the song 
 
50
name is not available. However the driver must not send this info unless it has some
 
51
information that is really important. In general the song name should NOT be something
 
52
generated automatically by the driver.
 
53
.PP
 
54
.SH "SEE ALSO"
 
55
.PP
 
56
\fIossddk_adev_get_songname(9ossddk)\fR
 
57
.LP
 
58
\fIWriting Sound Device Drivers with OSS DDK\fR
 
59
.LP
 
60
\fIOpen Sound System Programmer's Guide\fR