Other StreamLink commands

Enumerations

Functions
void	sl_create (streamlink *client, const char *subject, sl_subjecttype type, sl_commandlistener *listener, void *ctx)
	Create the given subject on the liebrator. More...
void	sl_throttle_subject (streamlink *client, const char *subject, sl_throttlecontrol command, sl_commandlistener *listener, void *ctx)
	Request throttling (conflation) on the specified subject. More...
void	sl_throttle_global (streamlink *client, sl_throttlecontrol command, sl_commandlistener *listener, void *ctx)
	Request throttling (conflation) on all subjects. More...
void	sl_delete (streamlink *client, const char *subject, sl_commandlistener *listener, void *ctx)
	Delete the given subject on the liebrator. More...

Detailed Description

Enumeration Type Documentation

enum sl_throttlecontrol

Enumeration that defines the Throttle Controls that are available.

Enumerator
sl_THROTTLE_UP	Increase the throttle level.
sl_THROTTLE_DOWN	Decrease the throttle level.
sl_THROTTLE_MIN	Set the throttle level to the minimum amount of throttling.
sl_THROTTLE_MAX	Set the throttle level to the maximum amount of throttling.
sl_THROTTLE_STOP	Stop sending updates to the client.
sl_THROTTLE_START	Start sending updates to the client again.
sl_THROTTLE_DEF	Set the throttle level to the default level.

Function Documentation

void sl_create	(	streamlink *	client,
		const char *	subject,
		sl_subjecttype	type,
		sl_commandlistener *	listener,
		void *	ctx
	)

Create the given subject on the liebrator.

Parameters

client	- The StreamLink client
subject	- The subject to create
type	- The type of subject to create
listener	- A listener which will receive success/failure messages for this publishing attempt
ctx	- User callback context which will passed to the listener

Note

The library does not take ownership of the memory passed into this function, it is the callers responsibility to release the memory used by the fields parameter.

The library does not copy the contents of listener, thus it should not be modified or unexpected effects may occur.

void sl_delete	(	streamlink *	client,
		const char *	subject,
		sl_commandlistener *	listener,
		void *	ctx
	)

Delete the given subject on the liebrator.

Parameters

client	- The StreamLink client
subject	- The subject to delete
listener	- A listener which will receive success/failure messages for this publishing attemp
ctx	- User callback context which will passed to the listener

Note

The library does not take ownership of the memory passed into this function, it is the callers responsibility to release the memory used by the fields parameter.

The library does not copy the contents of listener, thus it should not be modified or unexpected effects may occur.

void sl_throttle_global	(	streamlink *	client,
		sl_throttlecontrol	command,
		sl_commandlistener *	listener,
		void *	ctx
	)

Request throttling (conflation) on all subjects.

Parameters

client	- The StreamLink client
command	- The throttle level to request
listener	- A listener which will receive success/failure messages for this throttle command
ctx	- User callback context which will passed to the listener

Note

The library does not take ownership of the memory passed into this function, it is the callers responsibility to release the memory used by the fields parameter.

The library does not copy the contents of listener, thus it should not be modified or unexpected effects may occur.

void sl_throttle_subject	(	streamlink *	client,
		const char *	subject,
		sl_throttlecontrol	command,
		sl_commandlistener *	listener,
		void *	ctx
	)

Request throttling (conflation) on the specified subject.

Parameters

client	- The StreamLink client
subject	- The subject to throttle
command	- The throttle level to request
listener	- A listener which will receive success/failure messages for this throttle command
ctx	- User callback context which will passed to the listener

Note

The library does not take ownership of the memory passed into this function, it is the callers responsibility to release the memory used by the fields parameter.

The library does not copy the contents of listener, thus it should not be modified or unexpected effects may occur.