kmp_cc_api

The 'kmp_cc_api' directive configures the Kaltura Media Framework API for handling JSON events and routing HTTP requests in a specified location.

Синтаксисkmp_cc_api any;
По умолчаниюnone
Контекстlocation
Аргументыany

Описание

The 'kmp_cc_api' directive is used within the context of a location block in the NGINX configuration to enable the integration of Kaltura Media Framework's Common NGINX Module, primarily for communicating between the media components and a controller. This directive provides the necessary configuration to handle JSON-based HTTP events that the Kaltura components send to each other. When activated, it allows NGINX to process API requests efficiently, utilizing the defined route handlers that implement the JSON event handling logic.

Parameters for the 'kmp_cc_api' directive can be specified according to the requirements of the API being implemented, although it accepts any argument. This flexibility allows developers to define multiple routes with specific handlers for different media processing tasks, facilitating complex interactions between various components in the Kaltura ecosystem. By leveraging the capabilities of this directive, Kaltura can achieve efficient API route handling, JSON response management, and overall improved performance in media streaming applications.

Importantly, this directive must be defined within a location block, making it suitable for specific paths where Kaltura services are accessible. Ensuring correct implementation in conjunction with other Kaltura components can significantly enhance the orchestration and responsiveness of media processing tasks.

Пример конфига

location /api {
    kmp_cc_api;
}

Ensure that 'kmp_cc_api' is placed within a valid location block to function properly.

Be cautious with API path conflicts that may arise if multiple location blocks overlap.

Proper error handling must be implemented for JSON responses to avoid client-side failures.

← Ко всем директивам