rtmp_kmp_api
The rtmp_kmp_api directive configures an API endpoint for handling Kaltura Media Framework's JSON-based interactions within a specified location context.
Description
The rtmp_kmp_api directive serves as an endpoint for the Kaltura Media Framework, allowing users to interact with the framework's underlying components via HTTP-based JSON requests. It can process various HTTP methods such as GET, POST, PUT, and DELETE which are defined in the Kaltura Media Framework. This directive essentially enables the Kaltura controller to communicate with media components, making it possible to receive events and status information through the controller's orchestration mechanisms.
In the context of a location configuration, the rtmp_kmp_api directive does not take any arguments, thus the behavior is governed by the specified location block’s settings. When a request comes to this endpoint, the NGINX server will route it to the appropriate handler, manage the query parameters, as well as potentially gather data for JSON responses using the integrated API management functionality. It plays a critical role in updating and maintaining the status of different media elements in a live streaming environment, ultimately enhancing the media delivery process.
Config Example
location /kmp_api {
rtmp_kmp_api;
}Ensure the endpoint is defined properly within the location block to be reachable.
Using unsupported HTTP methods may yield unexpected results or errors.
Overlapping location blocks may interfere with the handling of requests directed to this endpoint.