paraslash

Paraslash network audio streaming tools


About
News
Download
Documentation
Development

para_recv

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
RECEIVERS
COPYRIGHT
NAME

para_recv - receive an audio stream

SYNOPSIS

para_recv [--help] [--detailed-help] [--version] [--loglevel=<severity>] [--receiver=<receiver_spec>]

DESCRIPTION

para_recv starts one paraslash receiver (http, dccp, udp or afh) to produce an audio stream in the same way para_audiod would download the stream from para_server (http, dccp or udp) or para_server makes a stream out of an audio file (afh). This is mostly useful for debugging.

Regardless of which receiver was started, the audio stream is written to stdout.

OPTIONS

Common options
The following options are implemented generically and are available for many of the commands.
-h
, --help

print help and exit

--detailed-help

print help, including all details, and exit

-V, --version

print version and exit

-l, --loglevel=<severity>

control amount of logging

values: debug, info, notice, warning, error, crit, emerg

Log only messages with severity greater or equal than the given value. Possible values:

debug: Produces really noisy output. info: Still noisy, but won’t fill up the disk quickly. notice: Indicates normal, but significant event. warning: Unexpected events that can be handled. error: Unhandled error condition. crit: System might be unreliable. emerg: Last message before exit.

Options for para_recv
-r
, --receiver=<receiver_spec>

select the receiver

Any options for the selected receiver must be quoted. Example:

-r ’http -i www.paraslash.org -p 8009’

If no receiver is given, http is assumed.

RECEIVERS

afh - make an audio stream from a local file
Usage: afh [--filename=<filename>] [--begin-chunk=<chunk_num>] [--end-chunk=<chunk_num>] [--just-in-time] [--no-header]

The afh (audio format handler) receiver extracts selected parts of the given audio file without decoding the file. Only complete chunks with respect to the underlying audio format are extracted.
-f
, --filename=<filename>

file to open

-b, --begin-chunk=<chunk_num>

skip the beginning of the file

The argument must be an integer between -num_chunks and num_chunks - 1, inclusively, where num_chunks is the total number of chunks. If chunk_num is negative, the given number of chunks are counted backwards from the end of the file. For example --begin-chunk -100 instructs the afh receiver to start at chunk num_chunks - 100. This is useful for cutting off the beginning of an audio file.

-e, --end-chunk=<chunk_num>

only write up to chunk chunk_num

For the chunk_num argument the same rules as for --begin-chunk apply. The default is to write up to the last chunk.

-j, --just-in-time

use timed writes

Write the specified data chunks ’just in time’, i.e., delay the write until data is needed by the decoder/player for an uninterrupted audio stream. This may be useful for third-party software.

-h, --no-header

do not write an audio file header

Some audio formats store information about the audio file in a format-specific header which is needed to decode any part of the file. For such formats the afh receiver generates a suitable header. This option changes the default behaviour, i.e. no header is written.

http - receive an audio stream over HTTP
Usage: http [--host=<host>] [--port=<portnumber>]
-i
, --host=<host>

IP address or hostname

default: localhost

Both IPv4 and IPv6 addresses are supported.

-p, --port=<portnumber>

TCP port to connect to

default: 8000

dccp - receive an audio stream over DCCP
Usage: dccp [--host=<host>] [--port=<portnumber>] [--ccid=<id>]
-i
, --host=<host>

IP address or hostname

default: localhost

Both IPv4 and IPv6 addresses are supported.

-p, --port=<portnumber>

TCP port to connect to

default: 8000

-c, --ccid=<id>

CCID preference(s) for this connection

When present exactly once, this option mandates the CCID for the sender-receiver connection. If it is passed more than once, it sets a preference list where the order of appearance signifies descending priority. For example, passing 4, 2, 3 creates the preference list (CCID-4, CCID-2, CCID-3), assigning CCID-4 highest preference.

The request is reconciled with the CCIDs on the server through the ’server-priority’ mechanism of RFC 4340 6.3.1/10. The server CCIDs can be listed by calling ’para_client sender dccp status’.

udp - receive an audio stream over UDP
Usage: udp [--host=<host>] [--port=<portnumber>] [--iface=<iface-name>]
-i
, --host=<host>

IP address or hostname

default: 224.0.1.38

The default address resolves to DANTZ.MCAST.NET and activates multicast.

-p, --port=<portnumber>

TCP port to connect to

default: 8000

--iface=<iface-name>

receiving udp multicast interface

COPYRIGHT

Written by Andre Noll
Copyright (C) 2019 Andre Noll
License: GNU GPL version 2
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
Report bugs to Andre Noll