Go to the documentation of this file.
25 #ifndef _AROARFW_PROTO_H_
26 #define _AROARFW_PROTO_H_
@ RSTREAMSTATE_UNUSED
The stream object is unused.
@ RCMD_CON_STREAM
Connect a stream to IO resource (to a socket)
@ RCMD_SET_META
Set meta data on a stream.
@ RPROTO_DAYTIME
Daytime protocol.
@ RPROTO_RSOUND
RSound protocol.
@ RCMD_SET_VOL
Change the volume of a stream.
@ RCMD_ACLCTL
Control Access Control List informations.
@ RPROTO_NONE
No protocol given, unused entry, use default.
@ RWHENCE_END
Point is relative to end of stream.
@ RTERM_TERM
Request the server to exit but wait for clients to exit.
@ RHQ_GOOD_NB
Hint is of good quality (very close to position) and requested position is not before this point.
@ RVOL_SET_UNMAPED
Set volume unmapped to current stream.
@ RROLE_VOICE
Voice stream (singer, speaker, ....)
rot_t
RoarAudio object types.
@ RIT_LISTEN
Information about listen sockets (this may be removed again in later versions of protocol specs)
@ RSTREAMSTATE_NEEDSEEK
like RSTREAMSTATE_ERROR but can be reset using SEEK command
@ RRPGMODE_TRACK
Use Track RPG information.
@ RCMD_GET_META
Get meta data of a stream.
rvolch_t
Parameter for type of volume change.
@ RCMD_IDENTIFY
Identify our client to the server.
rrole_t
Roles a stream can have.
@ RCMD_GET_STREAM
Get a stream object.
@ RDIR_OUTPUT
Waveform (and maybe other) stream attached to a driver.
@ RDIR_RECORD
Waveform recoard stream.
@ RITST_SERIAL
Freeform serial of device.
@ RSTREAMPARA_RPG
Get or set RePlay Gain settings of the stream.
@ RDIR_PLAY
Waveform Playback stream.
rit_t
Information types for SERVER_INFO command.
@ RSTREAMPARA_PROPTABLE
Get or set stream's PropTable.
@ RROLE_CLICK
Click track.
@ ROT_MIXER
Mixer streams. May be hardware mixer devices or software mixers.
@ RCMD_LOOKUP
Look up objects.
@ RCMD_ADD_DATA
Add data to the stream's input buffer.
@ RDIR_MIDI_IN
MIDI input stream.
@ RCMD_GET_STREAM_PARA
Get stream parameters.
@ RRPGMODE_ALBUMTRACK
Use Album RPG information, if not available use Track RPG information.
@ RSTREAMPARA_LTM
Get or set stream's Long Term Monitoring (LTM) parameters.
@ RAUTH_COOKIE
Send a binary-save cookie. This is normaly stored in a cookie file.
@ RPROTO_IRC
Internet Relay Chat (IRC)
@ RROLE_BEEP
Notify beep sounds.
@ RITST_DESCRIPTION
Freform description of server.
@ RCMD_SERVER_OINFO
Asks the server for information on outputs.
@ RSTREAMPARA_HASHTABLE
Get or set stream's HashTable.
@ RPROTO_RPLAY
RPlay protocol.
@ RROLE_MUSIC
Normal music.
@ RATTACH_OUTPUT
Output Attach: Attach stream to a output driver.
@ RCMD_ATTACH
Attach a stream to some resource (client, driver, ...)
@ RSTREAMSTATE_NEW
The stream is new. This means the stream have not been used yet.
@ RAUTH_PASSWORD
Send a user supplyed password. The user should get asked for the password.
@ RSTREAMSTATE_INITING
The stream is initing (is creating)
@ RITST_UN_MACHINE
Opering System host type, like uname -m.
@ RPROTO_AUTO
Auto select protocol.
@ RCMD_AUTHCTL
Control parameters for AUTH command.
@ RPROTO_WHOIS
Whois protocol.
ritst_t
Information types for Server Type (ITST) for SERVER_INFO command.
@ RPROTO_RPLD
RoarAudio Playlist Daemon Protocol.
@ RSTREAMPARA_WININFO
Get or set stream's hints for windowing systems.
@ RSTREAMSTATE_NULL
The stream does not exist.
@ RITST_UN_SYSNAME
Opering System name, like uname -s.
@ RSTREAMPARA_FLAGS
Operate on stream flags.
@ RSTREAMSTATE_OLD
The stream is old, This means it was arrady used for data.
@ RDIR_COMPLEX_OUT
Complex data output stream.
@ RAUTH_OPENPGP_SIGN
Use a OpenPGP based method using a signing key. (not recommented!)
@ RCMD_NOTIFY
Get Notified about events.
@ RROLE_NONE
No role assigned.
@ RATTACH_BRIDGE
Bridge Attach: Attches a bridge between diffrent subsystems.
rstandby_t
Possible standby modes.
@ RDIR_RECPLAY
Record and Play at the same time.
@ RCMD_NOOP
No Operation Commands.
@ RDIR_MONITOR
Waveform monitoring stream.
@ RHQ_BAD_NB
Bad hint, requested position is not before this point.
@ RCMD_SHIFT_DATA
Read some stream data from the server.
@ RRPGMODE_USER
Use RPG information as provided by the client (set via RSTREAMPARA_RPG)
@ RROLE_INSTRUMENT
General instrument.
@ ROT_MSGQUEUE
Message queues.
@ RCMD_PASSFH
Pass an open file handle to the server.
@ RDIR_LIGHT_OUT
Light Control output stream.
@ RCMD_SERVER_STATS
Asks the server for some stats.
@ RVOL_SET_MS
Set volume in a Mid/Side way (Volume/Balance)
@ RDIR_META
Meta data stream, obsolete.
@ RTERM_EXIT
Request the server to exit without waiting for clients to exit.
@ RCMD_LIST_META
List meta data of a stream.
@ RDIR_COMPLEX_IN
Complex data input stream.
@ RCMD_NEW_STREAM
Create a new stream.
@ RATTACH_SIMPLE
Simple Attach: Attach stream to a diffrent client.
@ RCMD_CAPS
Query or Tell capabilitys.
@ RCMD_KICK
Kick (terminate) a object from the server.
@ RAUTH_OPENPGP_AUTH
Use a OpenPGP based method using a auth key. (recommented)
@ RRPGMODE_NONE
Do not use RPG information.
@ RCMD_BEEP
Asks the server to generate a notify sound (beep)
@ RVOL_SET_ALL
Set all channels at once.
@ ROT_BRIDGE
Bridges between diffrent subsystems within a server.
@ RROLE_GAME
Sound generted by a game (see also RROLE_BACKGROUND_MUSIC)
@ RPROTO_FINGER
Finger protocol.
rwhence_t
Whence for SEEK command.
@ RDIR_BRIDGE
Bridge between subsystems or two objects in the same subsystem.
@ RFLAGCH_PROTECT
Protect a flag from being changed.
@ RSTREAMSTATE_UNKNOWN
The state of stream is unknown.
@ RAUTH_RHOST
Auth based on client's host or node name or address.
@ RCMD_SET_ACL
Set Access Control List informations (deprecated, do not use!)
@ RCMD_OK
Positive return value for request.
@ RCMD_LIST_STREAMS
List streams.
@ RCMD_EXEC_STREAM
Exec a stream.
@ RRPGMODE_DEFAULT
Use default RPG Mode. In this case the mode is selected by the server.
@ RDIR_THRU
Thru stream, this stream type sends raw copys of data passing thru a stream.
@ RCMD_GET_VOL
Get volume information of a stream.
@ RCT_STANDARDS
List of Standards.
@ RVOL_SET_ONE
Set only one channel.
@ RSTREAMPARA_ROLE
Get or set stream role.
@ ROT_LISTEN
Listen sockets.
@ RSTREAMPARA_NAME
Get or set stream name.
@ RITST_LOCATION
Freeform Location of server.
@ RDIR_RDTCS_OUT
Radio Data and Transmitter Control System output stream.
@ RHQ_NEAR
Requested position is near this point.
@ RROLE_RHYTHM
Rhythem instrument.
rrpgmode_t
Modes as used with RSTREAMPARA_RPG.
@ RIT_SERVER
General information about the server like implementation name and version.
@ RCMD_ERROR
Negative (error) return value for request.
@ RCMD_LIST_CLIENTS
List clients.
rstreamstat_t
States a stream can have.
@ RDIR_LIGHT_IN
Light Control input stream.
@ ROT_OUTPUT
Outputs of some kind, normally using some kind of (audio) driver.
@ RCMD_SERVER_INFO
Asks server for general information.
@ RDIR_MIDI_OUT
MIDI output stream.
@ RCMD_GETTIMEOFDAY
Get current system clock time of server.
@ RPROTO_DCC
Direct Client-to-Client (DCC)
@ RSTANDBY_INACTIVE
Standby is inactive.
@ RCMD_SEEK
Seek within a stream.
@ RDIR_DIRIDS
One more than the maximum direction ID.
@ RFLAGCH_RESET
Reset flag.
@ RCMD_CONCTL
Control Connection parameters.
@ RAUTH_IDENT
Use Ident service.
@ RPROTO_MPD
Music Player Daemon Protocol.
@ RPROTO_DHCP
Dynamic Host Configuration Protocol.
@ RROLE_MIXED
Already mixed data (for example outout of another sound daemon)
@ RCMD_WHOAMI
Asks the server for our client ID.
rattach_t
Types of attaches for the RCMD_ATTACH command.
rhq_t
Hint Quality values for SEEK command.
rterm_t
Parameter for server termination (RCMD_EXIT)
rdir_t
Type for stream directions.
@ RATTACH_SOURCE
Source Attach: Attach stream to a source driver.
@ RSTREAMPARA_CHANMAP
Get or set channel mapping.
@ RCMD_EXIT
Terminate the server.
@ RROLE_BACKGROUND_MUSIC
Background music.
@ RROLE_PHONE
Voice connections (RoN, VoIP, ISDN,...)
@ RHQ_EXACT
This is exackt possition (alias).
@ RCMD_AUTH
Auth our client on the server.
@ RAUTH_XAUTH
Use xauth cookie.
@ RCMD_SET_STANDBY
Ask the server to change it's standby state.
@ RCMD_DEVCTL
Device Control.
@ RROLE_VIDEO
Sound from a video.
@ RHQ_NEAR_NB
Requested position is near this point but not before this point.
@ RDIR_RAW_IN
Raw data input stream.
@ RPROTO_ICY
Nullsoft ICY protocol.
rflagch_t
Parameter for stream flag operation.
@ RDIR_RAW_OUT
Raw data output stream.
@ RPROTO_ESOUND
Old EsounD protocol.
@ RSTREAMSTATE_ERROR
Stream is in error condition.
@ RATTACH_MIXER
Mixer Attach: Attaches a mixer device.
@ RCMD_WAIT
Wait for events.
rcmd_t
Command values used for rmsg*_t.
@ RPROTO_ROARAUDIO
The RoarAudio protocol.
@ RROLE_EVENT
Event sounds?
@ RSTREAMPARA_INFO
Ask for info structure.
@ RCMD_GET_ACL
Get Access Control List informations (deprecated, do not use!)
@ RCMD_GET_CLIENT
Get a client object.
@ RPROTO_SIMPLE
PulseAudio Simple protocol.
@ RSTANDBY_ACTIVE
Standby is active.
@ RDIR_FILTER
Waveform filter stream.
@ RRPGMODE_TRACKALBUM
Use Track RPG information, if not available use Album RPG information.
@ RCMD_QUIT
Terminate the client connection.
@ RDIR_BIDIR
Waveform bidirectional stream (this is PLAY and MONITOR in one stream)
@ RPROTO_GAME
Protocol ID used by games.
@ RAUTH_OPENPGP_ENCRYPT
Use a OpenPGP based method using a encryption key.
@ RDIR_RDTCS_IN
Radio Data and Transmitter Control System input stream.
rcaps_t
Subtypes for CAPS command.
@ RCMD_SET_STREAM_PARA
Set stream parameters.
@ RAUTH_KERBEROS
Use Kerveros.
@ RITST_UN_RELEASE
Opering System release, like uname -r.
@ RRPGMODE_ALBUM
Use Album RPG information.
@ RCMD_CLIENTCTL
Control Client Parameters.
rstreampata_t
Sub-Commands for the RCMD_?ET_STREAM_PARA commands.
@ RROLE_UNKNOWN
Unknown role.
rauth_t
Auth methodes for the RCMD_AUTH command.
@ ROT_MSGBUS
Message busses.
@ RFLAGCH_TOGGLE
Toggle a given flag.
@ RCMD_GET_STANDBY
Get standby state from from server.
@ RSTREAMPARA_RADIO
Get or set radio transmitter or receiver parameters.
@ RITST_UN_NODENAME
Opering System node name, like uname -n.