Header: spf/api/modules/soft_pause_api.h
Structures
pause_ramp_params_t
Payload for the PARAM_ID_SOFT_PAUSE_RAMP_PARAMETERS parameter.
Members
Duration for which a constant gain is applied before calculating the next gain in the ramp up curve.
Specifies ramp up of the ramping curve.
Duration of the down ramp.
Duration for which the same gain is applied before calculating the next gain in the ramp down curve.
Specifies the ramp down of the ramping curve.
pause_resume_threshold_t
Payload of the PARAM_ID_SOFT_PAUSE_RESUME_THRESHOLD parameter.
Members
Specifies the set or get resume threshold (in Q15 format).
pause_downstream_delay_t
Payload of the PARAM_ID_SOFT_PAUSE_DOWNSTREAM_DELAY parameter.
Members
Specifies the downstream delay from the stream to the device leg.
pause_rampup_delay_t
Payload of the PARAM_ID_SOFT_PAUSE_RESUME_DEFERRED_RAMPUP parameter.
Members
Specifies the time that the module mutes before ramping up during resume.
Type Definitions
pause_ramp_params_t
pause_resume_threshold_t
pause_downstream_delay_t
pause_rampup_delay_t
Macros
PARAM_PAUSE_RAMPINGCURVE_LINEAR
Soft stepping linear ramping curve.
PARAM_PAUSE_RAMPINGCURVE_EXP
Exponential ramping curve.
PARAM_PAUSE_RAMPINGCURVE_LOG
Logarithmic ramping curve.
PARAM_PAUSE_RAMPINGCURVE_FRAC_EXP
Fractional exponent ramping curve.
Input port ID for the Soft Pause module.
PAUSE_DATA_OUTPUT_PORT
Output port ID for the Soft Pause module.
MODULE_ID_SOFT_PAUSE
Identifier for the Soft Pause module.
PARAM_ID_SOFT_PAUSE_RAMP_PARAMETERS
Identifier for the parameter that configures the ramp curve parameters for pause, where:
PARAM_ID_SOFT_PAUSE_START
Identifier for the parameter used to signal a pause to start.
PARAM_ID_SOFT_PAUSE_RESUME
Identifier for the parameter used to signal a resume to start.
PARAM_ID_SOFT_PAUSE_RESUME_THRESHOLD
Identifier for the parameter that configures the threshold required for a pause to resume.
PARAM_ID_SOFT_PAUSE_DOWNSTREAM_DELAY
Identifier for the parameter used to configure the downstream delay from the stream to a device leg.
PARAM_ID_SOFT_PAUSE_RESUME_DEFERRED_RAMPUP
Identifier for the parameter that configures the ramp up delay.
EVENT_ID_SOFT_PAUSE_PAUSE_COMPLETE
Identifier for the Pause Complete event that the Soft Pause module sends to the client.
EVENT_ID_SOFT_PAUSE_RESUME_COMPLETE
Identifier for the Resume Complete event that the Soft Pause module sends to the client.
