NVIDIA GStreamer DeepStream: Custom Message Functions
Description: This file specifies the NVIDIA DeepStream GStreamer custom message functions.
Definition in file includes/gst-nvdscustommessage.h.
Go to the source code of this file.
Functions | |
| G_BEGIN_DECLS GstMessage * | gst_nvmessage_new_stream_add (GstObject *obj, NvDsSensorInfo *sensor_info) |
| Creates a new Stream ADD message - denoting a new stream getting added to nvmultiurisrcbin. More... | |
| gboolean | gst_nvmessage_is_stream_add (GstMessage *message) |
| Determines whether a message is a stream ADD message. More... | |
| gboolean | gst_nvmessage_parse_stream_add (GstMessage *message, NvDsSensorInfo *sensor_info) |
| Parses the stream ID from a stream ADD message. More... | |
| GstMessage * | gst_nvmessage_new_stream_remove (GstObject *obj, NvDsSensorInfo *sensor_info) |
| Creates a new Stream REMOVE message - denoting a new stream getting removed from nvmultiurisrcbin. More... | |
| gboolean | gst_nvmessage_is_stream_remove (GstMessage *message) |
| Determines whether a message is a stream REMOVE message. More... | |
| gboolean | gst_nvmessage_parse_stream_remove (GstMessage *message, NvDsSensorInfo *sensor_info) |
| Parses the stream ID from a stream REMOVE message. More... | |
| gboolean | gst_nvmessage_parse_fps_stream_add (GstMessage *message, NvDsFPSSensorInfo *sensor_info) |
| Parses the stream ID from a stream ADD message. More... | |
| gboolean | gst_nvmessage_parse_fps_stream_remove (GstMessage *message, NvDsFPSSensorInfo *sensor_info) |
| Parses the stream ID from a stream REMOVE message. More... | |
| GstMessage * | gst_nvmessage_new_model_load (GstObject *obj, NvDsModelInfo *model_info) |
| Creates a new model-LOAD message - denoting a model getting loaded into nvmodelmux. More... | |
| gboolean | gst_nvmessage_is_model_load (GstMessage *message) |
| Determines whether a message is a model-LOAD message. More... | |
| gboolean | gst_nvmessage_parse_model_load (GstMessage *message, NvDsModelInfo *model_info) |
| Parses the model info from a model-LOAD message. More... | |
| GstMessage * | gst_nvmessage_new_model_unload (GstObject *obj, NvDsModelInfo *model_info) |
| Creates a new model-UNLOAD message - denoting a model getting unloaded from nvmodelmux. More... | |
| gboolean | gst_nvmessage_is_model_unload (GstMessage *message) |
| Determines whether a message is a model-UNLOAD message. More... | |
| gboolean | gst_nvmessage_parse_model_unload (GstMessage *message, NvDsModelInfo *model_info) |
| Parses the model info from a model-UNLOAD message. More... | |
| GstMessage * | gst_nvmessage_new_model_event (GstObject *obj, NvDsModelEventInfo *info) |
| Creates a new model-event message - denoting an asynchronous model-plane operation that has actually completed, such as an engine warmed, a version torn down, an OTA committed or a reroute settled. More... | |
| gboolean | gst_nvmessage_is_model_event (GstMessage *message) |
| Determines whether a message is a model-event message. More... | |
| gboolean | gst_nvmessage_parse_model_event (GstMessage *message, NvDsModelEventInfo *info) |
| Parses the event info from a model-event message. More... | |
| GstQuery * | gst_nvquery_model_status_new (void) |
| Creates a new empty (unfiltered) model-status query, to be sent downstream via peer_query. More... | |
| GstQuery * | gst_nvquery_model_status_new_filtered (const gchar *model_name, const gchar *model_version, const gchar *stream_name, gint source_id) |
| Creates a model-status query carrying an optional request filter. More... | |
| gboolean | gst_nvquery_model_status_parse_request (GstQuery *query, const gchar **model_name, const gchar **model_version, const gchar **stream_name, gint *source_id) |
| Parses the request filter from a model-status query. More... | |
| gboolean | gst_nvquery_is_model_status (GstQuery *query) |
| Determines whether a query is a model-status query. More... | |
| void | gst_nvquery_model_status_set_response (GstQuery *query, const gchar *json) |
| Sets the JSON status response on a model-status query. More... | |
| gboolean | gst_nvquery_model_status_parse_response (GstQuery *query, const gchar **json) |
| Parses the JSON status response from a model-status query. More... | |
| GstQuery * | gst_nvquery_stream_route_new (void) |
| Creates a new stream-route query - the read side of the routing plane, which the REST server sends downstream for the model-managing element to answer. More... | |
| GstQuery * | gst_nvquery_stream_route_new_filtered (const gchar *camera_id) |
| Creates a stream-route query carrying an optional point lookup. More... | |
| gboolean | gst_nvquery_stream_route_parse_request (GstQuery *query, const gchar **camera_id, gboolean *filtered) |
| Parses the request filter from a stream-route query. More... | |
| gboolean | gst_nvquery_is_stream_route (GstQuery *query) |
| Determines whether a query is a stream-route query. More... | |
| void | gst_nvquery_stream_route_set_response (GstQuery *query, const gchar *json) |
| Sets the JSON routing response on a stream-route query. More... | |
| gboolean | gst_nvquery_stream_route_parse_response (GstQuery *query, const gchar **json) |
| Parses the JSON routing response from a stream-route query. More... | |
| GstQuery * | gst_nvquery_control_new (const gchar *op, const gchar *value_json) |
| Creates a new control-op admission query. More... | |
| gboolean | gst_nvquery_is_control (GstQuery *query) |
| Determines whether a query is a control-op admission query. More... | |
| gboolean | gst_nvquery_control_parse_request (GstQuery *query, const gchar **op, const gchar **value_json) |
| Parses the op and value JSON from a control-op admission query. More... | |
| void | gst_nvquery_control_set_response (GstQuery *query, gint http_code, const gchar *err_code, const gchar *reason, const gchar *hint) |
| Writes the admission verdict on a control-op admission query. More... | |
| gboolean | gst_nvquery_control_parse_response (GstQuery *query, gint *http_code, const gchar **err_code, const gchar **reason, const gchar **hint) |
| Parses the admission verdict from a control-op admission query. More... | |
| GstMessage * | gst_nvmessage_new_model_update (GstObject *obj, NvDsModelInfo *model_info) |
| Creates a new model-update message - denoting an in-place checkpoint transition on the model plane. More... | |
| gboolean | gst_nvmessage_is_model_update (GstMessage *message) |
| Determines whether a message is a model-update message. More... | |
| gboolean | gst_nvmessage_parse_model_update (GstMessage *message, NvDsModelInfo *model_info) |
| Parses the model info from a model-update message. More... | |
| GstMessage * | gst_nvmessage_new_stream_route (GstObject *obj, NvDsRouteInfo *route_info) |
| Creates a new stream-route message - the write side of the routing plane. More... | |
| gboolean | gst_nvmessage_is_stream_route (GstMessage *message) |
| Determines whether a message is a stream-route message. More... | |
| gboolean | gst_nvmessage_parse_stream_route (GstMessage *message, NvDsRouteInfo *route_info) |
| Parses the route info from a stream-route message. More... | |
| GstMessage * | gst_nvmessage_force_pipeline_eos (GstObject *obj, gboolean force_eos) |
| Sends custom message to force-eos on the pipeline. More... | |
| gboolean | gst_nvmessage_parse_force_pipeline_eos (GstMessage *message, gboolean *force_eos) |
| Parses the force_eos from a force eos message. More... | |
| gboolean | gst_nvmessage_is_force_pipeline_eos (GstMessage *message) |
| Determines whether a message is a force pipeline eos message. More... | |
| GstMessage * | gst_nvmessage_reconnect_attempt_exceeded (GstObject *obj, NvDsRtspAttemptsInfo *rtsp_info) |
| Creates a new attempt-exceeded message - denoting a reconnection attempt is exceeded for a rtsp uri. More... | |
| gboolean | gst_nvmessage_parse_reconnect_attempt_exceeded (GstMessage *message, NvDsRtspAttemptsInfo *rtsp_info) |
| Parses the NvDsRtspAttemptsInfo from a attempt-exceeded message. More... | |
| gboolean | gst_nvmessage_is_reconnect_attempt_exceeded (GstMessage *message) |
| Determines whether a message is a attempt-exceeded message. More... | |
| GstMessage* gst_nvmessage_force_pipeline_eos | ( | GstObject * | obj, |
| gboolean | force_eos | ||
| ) |
Sends custom message to force-eos on the pipeline.
The element on which custom message related to eos is to be sent.
params[in] object A gboject on which custom message to be sent params[in] force_eos A force_eos variable
| gboolean gst_nvmessage_is_force_pipeline_eos | ( | GstMessage * | message | ) |
Determines whether a message is a force pipeline eos message.
params[in] message A pointer to the message to be checked.
| gboolean gst_nvmessage_is_model_event | ( | GstMessage * | message | ) |
Determines whether a message is a model-event message.
params[in] message A pointer to the message to be checked.
| gboolean gst_nvmessage_is_model_load | ( | GstMessage * | message | ) |
Determines whether a message is a model-LOAD message.
params[in] message A pointer to the message to be checked.
| gboolean gst_nvmessage_is_model_unload | ( | GstMessage * | message | ) |
Determines whether a message is a model-UNLOAD message.
params[in] message A pointer to the message to be checked.
| gboolean gst_nvmessage_is_model_update | ( | GstMessage * | message | ) |
Determines whether a message is a model-update message.
params[in] message A pointer to the message to be checked.
| gboolean gst_nvmessage_is_reconnect_attempt_exceeded | ( | GstMessage * | message | ) |
Determines whether a message is a attempt-exceeded message.
params[in] message A pointer to the message to be checked.
| gboolean gst_nvmessage_is_stream_add | ( | GstMessage * | message | ) |
Determines whether a message is a stream ADD message.
params[in] message A pointer to the message to be checked.
| gboolean gst_nvmessage_is_stream_remove | ( | GstMessage * | message | ) |
Determines whether a message is a stream REMOVE message.
params[in] message A pointer to the message to be checked.
| gboolean gst_nvmessage_is_stream_route | ( | GstMessage * | message | ) |
Determines whether a message is a stream-route message.
params[in] message A pointer to the message to be checked.
| GstMessage* gst_nvmessage_new_model_event | ( | GstObject * | obj, |
| NvDsModelEventInfo * | info | ||
| ) |
Creates a new model-event message - denoting an asynchronous model-plane operation that has actually completed, such as an engine warmed, a version torn down, an OTA committed or a reroute settled.
This is the stream ADD/REMOVE notification's counterpart for the model plane: an app subscribes on the bus and reacts in the same way.
params[in] obj The GStreamer object creating the message. params[in] info A pointer to NvDsModelEventInfo describing the operation which completed.
| GstMessage* gst_nvmessage_new_model_load | ( | GstObject * | obj, |
| NvDsModelInfo * | model_info | ||
| ) |
Creates a new model-LOAD message - denoting a model getting loaded into nvmodelmux.
The message carries the request "value" object as verbatim JSON, so one schema is used end-to-end and the consumer parses the document.
params[in] obj The GStreamer object creating the message. params[in] model_info A pointer to NvDsModelInfo holding value_json.
| GstMessage* gst_nvmessage_new_model_unload | ( | GstObject * | obj, |
| NvDsModelInfo * | model_info | ||
| ) |
Creates a new model-UNLOAD message - denoting a model getting unloaded from nvmodelmux.
params[in] obj The GStreamer object creating the message. params[in] model_info A pointer to NvDsModelInfo holding value_json.
| GstMessage* gst_nvmessage_new_model_update | ( | GstObject * | obj, |
| NvDsModelInfo * | model_info | ||
| ) |
Creates a new model-update message - denoting an in-place checkpoint transition on the model plane.
This never routes streams; routing is the stream-route message below.
params[in] obj The GStreamer object creating the message. params[in] model_info A pointer to NvDsModelInfo holding value_json.
| G_BEGIN_DECLS GstMessage* gst_nvmessage_new_stream_add | ( | GstObject * | obj, |
| NvDsSensorInfo * | sensor_info | ||
| ) |
Creates a new Stream ADD message - denoting a new stream getting added to nvmultiurisrcbin.
params[in] obj The GStreamer object creating the message. params[in] sensor_info Sensor info of the stream which is getting added into nvmultiurisrcbin
| GstMessage* gst_nvmessage_new_stream_remove | ( | GstObject * | obj, |
| NvDsSensorInfo * | sensor_info | ||
| ) |
Creates a new Stream REMOVE message - denoting a new stream getting removed from nvmultiurisrcbin.
params[in] obj The GStreamer object creating the message. params[in] sensor_info Sensor info of the stream which is getting removed from nvmultiurisrcbin
| GstMessage* gst_nvmessage_new_stream_route | ( | GstObject * | obj, |
| NvDsRouteInfo * | route_info | ||
| ) |
Creates a new stream-route message - the write side of the routing plane.
The message carries the declarative routing document as verbatim JSON, with its routes augmented with the source IDs resolved by nvmultiurisrcbin.
params[in] obj The GStreamer object creating the message. params[in] route_info A pointer to NvDsRouteInfo holding value_json.
| gboolean gst_nvmessage_parse_force_pipeline_eos | ( | GstMessage * | message, |
| gboolean * | force_eos | ||
| ) |
Parses the force_eos from a force eos message.
params[in] message A pointer to a force eos message. params[out] force_eos A pointer to force_eos variable
| gboolean gst_nvmessage_parse_fps_stream_add | ( | GstMessage * | message, |
| NvDsFPSSensorInfo * | sensor_info | ||
| ) |
Parses the stream ID from a stream ADD message.
The stream ID is the index of the stream which is getting added to nvmultiurisrcbin
params[in] message A pointer to a stream ADD message. params[out] stream_id A pointer to NvDsSensorInfo The string NvDsFPSSensorInfo->sensor_id should not be modified, and remains valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.
| gboolean gst_nvmessage_parse_fps_stream_remove | ( | GstMessage * | message, |
| NvDsFPSSensorInfo * | sensor_info | ||
| ) |
Parses the stream ID from a stream REMOVE message.
The stream ID is the index of the stream which is getting removed from nvmultiurisrcbin
params[in] message A pointer to a stream REMOVE message. params[out] stream_id A pointer to NvDsSensorInfo The string NvDsFPSSensorInfo->sensor_id should not be modified, and remains valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.
| gboolean gst_nvmessage_parse_model_event | ( | GstMessage * | message, |
| NvDsModelEventInfo * | info | ||
| ) |
Parses the event info from a model-event message.
params[in] message A pointer to a model-event message. params[out] info A pointer to NvDsModelEventInfo The strings in NvDsModelEventInfo should not be modified, and remain valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.
| gboolean gst_nvmessage_parse_model_load | ( | GstMessage * | message, |
| NvDsModelInfo * | model_info | ||
| ) |
Parses the model info from a model-LOAD message.
params[in] message A pointer to a model-LOAD message. params[out] model_info A pointer to NvDsModelInfo The string NvDsModelInfo->value_json should not be modified, and remains valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.
| gboolean gst_nvmessage_parse_model_unload | ( | GstMessage * | message, |
| NvDsModelInfo * | model_info | ||
| ) |
Parses the model info from a model-UNLOAD message.
params[in] message A pointer to a model-UNLOAD message. params[out] model_info A pointer to NvDsModelInfo The string NvDsModelInfo->value_json should not be modified, and remains valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.
| gboolean gst_nvmessage_parse_model_update | ( | GstMessage * | message, |
| NvDsModelInfo * | model_info | ||
| ) |
Parses the model info from a model-update message.
params[in] message A pointer to a model-update message. params[out] model_info A pointer to NvDsModelInfo The string NvDsModelInfo->value_json should not be modified, and remains valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.
| gboolean gst_nvmessage_parse_reconnect_attempt_exceeded | ( | GstMessage * | message, |
| NvDsRtspAttemptsInfo * | rtsp_info | ||
| ) |
Parses the NvDsRtspAttemptsInfo from a attempt-exceeded message.
params[in] message A pointer to a attempt-exceeded message. params[out] NvDsRtspAttemptsInfo A pointer to NvDsRtspAttemptsInfo
| gboolean gst_nvmessage_parse_stream_add | ( | GstMessage * | message, |
| NvDsSensorInfo * | sensor_info | ||
| ) |
Parses the stream ID from a stream ADD message.
The stream ID is the index of the stream which is getting added to nvmultiurisrcbin
params[in] message A pointer to a stream ADD message. params[out] stream_id A pointer to NvDsSensorInfo The string NvDsSensorInfo->sensor_id should not be modified, and remains valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.
| gboolean gst_nvmessage_parse_stream_remove | ( | GstMessage * | message, |
| NvDsSensorInfo * | sensor_info | ||
| ) |
Parses the stream ID from a stream REMOVE message.
The stream ID is the index of the stream which is getting removed from nvmultiurisrcbin
params[in] message A pointer to a stream REMOVE message. params[out] stream_id A pointer to NvDsSensorInfo The string NvDsSensorInfo->sensor_id should not be modified, and remains valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.
| gboolean gst_nvmessage_parse_stream_route | ( | GstMessage * | message, |
| NvDsRouteInfo * | route_info | ||
| ) |
Parses the route info from a stream-route message.
params[in] message A pointer to a stream-route message. params[out] route_info A pointer to NvDsRouteInfo The string NvDsRouteInfo->value_json should not be modified, and remains valid until the next call to a gst_nvmessage_parse*() function with the given message. Please use or make copy within the bus callback scope.
| GstMessage* gst_nvmessage_reconnect_attempt_exceeded | ( | GstObject * | obj, |
| NvDsRtspAttemptsInfo * | rtsp_info | ||
| ) |
Creates a new attempt-exceeded message - denoting a reconnection attempt is exceeded for a rtsp uri.
params[in] obj The GStreamer object creating the message. params[in] rtsp_info rtsp info of the stream which exceeds rtsp reconnection attempt
| GstQuery* gst_nvquery_control_new | ( | const gchar * | op, |
| const gchar * | value_json | ||
| ) |
Creates a new control-op admission query.
The query is sent downstream via peer_query by the REST layer, so that the model-managing element returns its admission verdict in the same call. It is used for model/unload; the asynchronous ops keep the in-band event instead.
params[in] op The plane path, for example "model/unload". params[in] value_json The request "value" object, as verbatim JSON.
| gboolean gst_nvquery_control_parse_request | ( | GstQuery * | query, |
| const gchar ** | op, | ||
| const gchar ** | value_json | ||
| ) |
Parses the op and value JSON from a control-op admission query.
params[in] query A pointer to a control-op admission query. params[out] op A pointer to the plane path. params[out] value_json A pointer to the request "value" object. The strings should not be modified, and remain valid until the query is unreffed. Please use or make copy within scope.
| gboolean gst_nvquery_control_parse_response | ( | GstQuery * | query, |
| gint * | http_code, | ||
| const gchar ** | err_code, | ||
| const gchar ** | reason, | ||
| const gchar ** | hint | ||
| ) |
Parses the admission verdict from a control-op admission query.
params[in] query A pointer to a control-op admission query. params[out] http_code A pointer to the verdict HTTP code. params[out] err_code A pointer to the stable error ID. params[out] reason A pointer to the reason for the verdict. params[out] hint A pointer to the optional hint. The strings should not be modified, and remain valid until the query is unreffed. Please use or make copy within scope.
| void gst_nvquery_control_set_response | ( | GstQuery * | query, |
| gint | http_code, | ||
| const gchar * | err_code, | ||
| const gchar * | reason, | ||
| const gchar * | hint | ||
| ) |
Writes the admission verdict on a control-op admission query.
params[in] query A pointer to a control-op admission query. params[in] http_code The verdict: 202 if accepted, 400 if rejected. params[in] err_code A stable error ID; NULL or "" when accepted. params[in] reason A human-readable reason for the verdict. params[in] hint An optional hint; may be NULL.
| gboolean gst_nvquery_is_control | ( | GstQuery * | query | ) |
Determines whether a query is a control-op admission query.
params[in] query A pointer to the query to be checked.
| gboolean gst_nvquery_is_model_status | ( | GstQuery * | query | ) |
Determines whether a query is a model-status query.
params[in] query A pointer to the query to be checked.
| gboolean gst_nvquery_is_stream_route | ( | GstQuery * | query | ) |
Determines whether a query is a stream-route query.
params[in] query A pointer to the query to be checked.
| GstQuery* gst_nvquery_model_status_new | ( | void | ) |
Creates a new empty (unfiltered) model-status query, to be sent downstream via peer_query.
The app answers with a JSON status string at its bin boundary, which decouples the in-plugin REST thread from the app-owned model state.
| GstQuery* gst_nvquery_model_status_new_filtered | ( | const gchar * | model_name, |
| const gchar * | model_version, | ||
| const gchar * | stream_name, | ||
| gint | source_id | ||
| ) |
Creates a model-status query carrying an optional request filter.
Pass NULL, NULL, NULL and -1 for no filter (full dump). The response schema is identical either way.
params[in] model_name Only that model, or NULL for every model. params[in] model_version Only that (name, version) instance, or NULL for every version of the name. Optional, and needs model_name to be set. params[in] stream_name Only that stream, or NULL for every stream. params[in] source_id Only that stream, or -1 for every stream.
| gboolean gst_nvquery_model_status_parse_request | ( | GstQuery * | query, |
| const gchar ** | model_name, | ||
| const gchar ** | model_version, | ||
| const gchar ** | stream_name, | ||
| gint * | source_id | ||
| ) |
Parses the request filter from a model-status query.
params[in] query A pointer to a model-status query. params[out] model_name A pointer to the model name; "" if unset. params[out] model_version A pointer to the model version; "" if unset. params[out] stream_name A pointer to the stream name; "" if unset. params[out] source_id A pointer to the source ID; -1 if unset. The strings should not be modified, and remain valid until the query is unreffed. Please use or make copy within scope.
| gboolean gst_nvquery_model_status_parse_response | ( | GstQuery * | query, |
| const gchar ** | json | ||
| ) |
Parses the JSON status response from a model-status query.
params[in] query A pointer to a model-status query. params[out] json A pointer to the JSON response. The string should not be modified, and remains valid until the query is unreffed.
| void gst_nvquery_model_status_set_response | ( | GstQuery * | query, |
| const gchar * | json | ||
| ) |
Sets the JSON status response on a model-status query.
params[in] query A pointer to a model-status query. params[in] json The JSON status response.
| GstQuery* gst_nvquery_stream_route_new | ( | void | ) |
Creates a new stream-route query - the read side of the routing plane, which the REST server sends downstream for the model-managing element to answer.
| GstQuery* gst_nvquery_stream_route_new_filtered | ( | const gchar * | camera_id | ) |
Creates a stream-route query carrying an optional point lookup.
The filter is a camera_id, the same identifier that POST /api/v1/stream/route accepts. Pass NULL, and only NULL, for no filter; any non-NULL value, including an empty string, is a filter which is present, so a malformed point lookup matches nothing instead of returning every route.
params[in] camera_id The camera ID to look up, or NULL for no filter.
| gboolean gst_nvquery_stream_route_parse_request | ( | GstQuery * | query, |
| const gchar ** | camera_id, | ||
| gboolean * | filtered | ||
| ) |
Parses the request filter from a stream-route query.
params[in] query A pointer to a stream-route query. params[out] camera_id A pointer to the camera ID. The string should not be modified, and remains valid until the query is unreffed. Please use or make a copy within scope. params[out] filtered A pointer to the filter-present flag. The flag is authoritative, not the string: true with an empty camera_id is a present filter matching nothing.
| gboolean gst_nvquery_stream_route_parse_response | ( | GstQuery * | query, |
| const gchar ** | json | ||
| ) |
Parses the JSON routing response from a stream-route query.
params[in] query A pointer to a stream-route query. params[out] json A pointer to the JSON response. The string should not be modified, and remains valid until the query is unreffed.
| void gst_nvquery_stream_route_set_response | ( | GstQuery * | query, |
| const gchar * | json | ||
| ) |
Sets the JSON routing response on a stream-route query.
params[in] query A pointer to a stream-route query. params[in] json The JSON routing response.