persist_opaque
The 'persist_opaque' directive determines whether to maintain opaque context during API calls.
Description
The 'persist_opaque' directive is utilized in the Kaltura Media Framework Common NGINX Module to manage the persistence of an opaque context across requests. When the directive is set to a value of '1', it allows the API to carry over specific contextual information needed for subsequent API interactions. This can be instrumental in scenarios where continuity of state is crucial for the media processing pipeline, such as during live streaming sessions or when interactive media requirements necessitate tracking state across requests.
This directive also accepts a parameter that specifies the persistence behavior. For example, if set to '1', the opaque context will be preserved and made available to the API methods handling subsequent requests. However, if the persistence feature is turned off or set to '0', the opaque context will not be carried over, which may lead to issues in state consistency across multiple API calls. Understanding how this directive interacts with the API request lifecycle is essential for developers working within the Kaltura framework to maintain optimal function and user experience in live media applications.
Config Example
location /api {
persist_opaque on;
proxy_pass http://backend_api;
}Ensure that the opaque context does not become stale; manage state carefully across API calls.
Using 'persist_opaque off' might lead to loss of important contextual information, resulting in errors in media handling.
Check for compatibility with other modules or directives that may affect state management in the API.