Session Capabilities API

Functions
AP_SESSION_API void	AP_SESSION_AddCapabilities (AP_SESSION_Interface *smi, const char *sessionName, const char *const capabilities[], size_t capsSize)
AP_SESSION_API void	AP_SESSION_AddCapabilityParams (AP_SESSION_Interface *smi, const char *sessionName, const char *streamName, const char *key, const char *type, const char *defaultValue, const char *const allowedValues[], size_t allowsize, const char *description, AP_bool required)
AP_SESSION_API void	AP_SESSION_AddCapabilitiesById (AP_SESSION_Interface *smi, AP_int64 sourceId, const char *const capabilities[], size_t capsSize)
AP_SESSION_API void	AP_SESSION_AddCapabilityParamsById (AP_SESSION_Interface *smi, AP_int64 sourceId, const char *streamName, const char *key, const char *type, const char *defaultValue, const char *const allowedValues[], size_t allowsize, const char *description, AP_bool required)
AP_SESSION_API AP_bool	AP_SESSION_HasCapability (AP_SESSION_Interface *smi, const AP_int64 sourceId, const char *capability)

Detailed Description

Session Capabilities API

See also

Supported Capabilities

Function Documentation

AP_SESSION_AddCapabilities()

AP_SESSION_API void AP_SESSION_AddCapabilities	(	AP_SESSION_Interface *	smi,
		const char *	sessionName,
		const char *const	capabilities[],
		size_t	capsSize
	)

Add capabilities for a session by name.

Parameters

smi	The AP_SESSION_Interface to use.
sessionName	The name of the session these capabilities are for.
capabilities	An array of capabilities for this session.
capsSize	The size of the capabilities array.

See also

AP_SESSION_RegisterSession

AP_SESSION_RegisterSessions

AP_SESSION_AddCapabilityParams

AP_SESSION_AddCapabilitiesById()

AP_SESSION_API void AP_SESSION_AddCapabilitiesById	(	AP_SESSION_Interface *	smi,
		AP_int64	sourceId,
		const char *const	capabilities[],
		size_t	capsSize
	)

Add capabilities for a session by id.

Parameters

smi	The AP_SESSION_Interface to use.
sourceId	The id of the session these capabilities are for.
capabilities	An array of capabilities for this session.
capsSize	The size of the capabilities array.

See also

AP_SESSION_RegisterSession

AP_SESSION_RegisterSessions

AP_SESSION_AddCapabilityParamsById

AP_SESSION_AddCapabilityParams()

AP_SESSION_API void AP_SESSION_AddCapabilityParams	(	AP_SESSION_Interface *	smi,
		const char *	sessionName,
		const char *	streamName,
		const char *	key,
		const char *	type,
		const char *	defaultValue,
		const char *const	allowedValues[],
		size_t	allowsize,
		const char *	description,
		AP_bool	required
	)

Add capability parameters for a session by name.

Parameters

smi	The AP_SESSION_Interface to use.
sessionName	The name of the session this parameter is for.
streamName	The name of the stream/capability this parameter is for.
key	The name of the parameter to add.
type	The type of this parameter (i.e. "float", "string").
defaultValue	The default value for this parameter.
allowedValues	An array of allowed values for this parameter.
allowsize	The size of the allowValues array.
description	The description of the parameter to be added.
required	'true' if this parameter is required, else 'false'.

See also

AP_SESSION_AddSession

AP_SESSION_RegisterSession

AP_SESSION_RegisterSessions

AP_SESSION_AddCapabilityParamsById()

AP_SESSION_API void AP_SESSION_AddCapabilityParamsById	(	AP_SESSION_Interface *	smi,
		AP_int64	sourceId,
		const char *	streamName,
		const char *	key,
		const char *	type,
		const char *	defaultValue,
		const char *const	allowedValues[],
		size_t	allowsize,
		const char *	description,
		AP_bool	required
	)

Add capability parameters for a session by name.

Parameters

smi	The AP_SESSION_Interface to use.
sourceId	The id of the session this parameter is for.
streamName	The name of the stream/capability this parameter is for.
key	The name of the parameter to add.
type	The type of this parameter (i.e. "float", "string").
defaultValue	The default value for this parameter.
allowedValues	An array of allowed values for this parameter.
allowsize	The size of the allowValues array.
description	The description of the parameter to be added.
required	'true' if this parameter is required, else 'false'.

See also

AP_SESSION_AddSession

AP_SESSION_RegisterSession

AP_SESSION_RegisterSessions

AP_SESSION_HasCapability()

AP_SESSION_API AP_bool AP_SESSION_HasCapability	(	AP_SESSION_Interface *	smi,
		const AP_int64	sourceId,
		const char *	capability
	)

Query if a session has a capability.

Parameters

smi	The AP_SESSION_Interface to use.
sourceId	The id of the session to query.
capability	The name of the capability to query for.

Returns

True if session has the capability, else false.