Shared Input (between Quortex Link and Quortex Play) - Limited Availability
This article describes how Quortex Play can reuse an input configured in Quortex Link.
This addresses customers who wish to ingest their input streams once and share them between both products.
Shared inputs simplify operations by:
Reducing the configuration complexity
Propagating input enabling and disabling actions from Quortex Link to Quortex Play.
This feature is in a beta stage, with limited availability
A shared input is an input configured in Quortex Link that can be imported and reused in Quortex Play.
Once successfully imported, the Quortex Play input is bound to the Quortex Link input. As a result:
Enabling and disabling actions performed on a Quortex Link input immediately impacts the Quortex Play input similarly.
The operational status of the Quortex Play input is mapped to the corresponding Quortex Link input.
In Quortex Link: Create an input and configure the stream(s) for that input as usual. By default, the new input will be available for other Quortex applications.
If an input access has been restricted and you want to update the availability, you can click on the shield icon in the top right-hand corner.
In Quortex Play:
Create an input with the import from Quortex Link option as illustrated below
Select the required input to import from Link
Optionally customize the input name
The input is shared which implies that the operational status is the same for both products, except
When Quortex Play attempts to bind to the Quortex Link input. This is a transitory state.
If the binding action failed.
Imported inputs are listed with a "Quortex Link" type in the Inputs view as shown below:
From Quortex Link:
Inputs shared with Quortex Play are flagged so that the Quortex Link operator is aware of potential impacts on Quortex Play.
The configuration of a shared input can be updated and this impacts Quortex Play as well.
From Quortex Play:
The configuration of a shared input (streams attributes) can't be changed: The configuration is owned by the Quortex Link operator.
From Quortex Link:
A shared input can't be deleted while it is used by Quortex Play.
To delete a shared input, it must be deleted in Quortex Play first.
Using shared inputs in Quortex Play with the API follows the same logic as in the UI.
A typical workflow is given below:
Get Quortex Link inputs
GET {{ api }}/1.0/pools/{{pool_uuid}}/inputs/available
The response will contain all available inputs.
Parse the response to identify the input you want to import
{
"count": 3,
"results": [
{
"uuid": "src_EycxTnJf",
"name": "Src6",
"pool_uuid": "pool_pm68TQXE",
"pool_name": "YBN-Test",
"usable": true,
"app": "link",
"status": "active",
"redundancy": "single"
},
{
"uuid": "src_XWxCP9TH",
"name": "Src7",
"pool_uuid": "pool_pm68TQXE",
"pool_name": "YBN-Test",
"usable": true,
"app": "link",
"status": "active",
"redundancy": "single"
},
{
"uuid": " src_owyTnjIA",
"name": "Input1 shared",
"pool_uuid": "pool_pm68TQXE",
"pool_name": "YBN-Test",
"usable": true,
"app": "link",
"status": "active",
"redundancy": "single"
}
]
}
Create a shared input with the selected input uuid
POST {{ api }}/1.0/pools/{{pool_uuid}}/inputs
{
"name": "my shared input name",
"streams": [
{
"name": "stream #1",
"type": "app",
"app": {"input_uuid": " src_owyTnjIA"}
}
]
}
Where "input_uuid" corresponds to the Quortex Link input to be imported.
Input sharing assumes that Quortex Link and Quortex Play are in the same cloud region.
You can only bind one shared input to the Link input.
This addresses customers who wish to ingest their input streams once and share them between both products.
Shared inputs simplify operations by:
Reducing the configuration complexity
Propagating input enabling and disabling actions from Quortex Link to Quortex Play.
This feature is in a beta stage, with limited availability
Definition
A shared input is an input configured in Quortex Link that can be imported and reused in Quortex Play.
Once successfully imported, the Quortex Play input is bound to the Quortex Link input. As a result:
Enabling and disabling actions performed on a Quortex Link input immediately impacts the Quortex Play input similarly.
The operational status of the Quortex Play input is mapped to the corresponding Quortex Link input.
Configuring a shared input
In Quortex Link: Create an input and configure the stream(s) for that input as usual. By default, the new input will be available for other Quortex applications.
If an input access has been restricted and you want to update the availability, you can click on the shield icon in the top right-hand corner.
In Quortex Play:
Create an input with the import from Quortex Link option as illustrated below
Select the required input to import from Link
Optionally customize the input name
Monitoring status
The input is shared which implies that the operational status is the same for both products, except
When Quortex Play attempts to bind to the Quortex Link input. This is a transitory state.
If the binding action failed.
Imported inputs are listed with a "Quortex Link" type in the Inputs view as shown below:
Editing a shared input
From Quortex Link:
Inputs shared with Quortex Play are flagged so that the Quortex Link operator is aware of potential impacts on Quortex Play.
The configuration of a shared input can be updated and this impacts Quortex Play as well.
From Quortex Play:
The configuration of a shared input (streams attributes) can't be changed: The configuration is owned by the Quortex Link operator.
Deleting a shared input
From Quortex Link:
A shared input can't be deleted while it is used by Quortex Play.
To delete a shared input, it must be deleted in Quortex Play first.
API typical workflow
Using shared inputs in Quortex Play with the API follows the same logic as in the UI.
A typical workflow is given below:
Get Quortex Link inputs
GET {{ api }}/1.0/pools/{{pool_uuid}}/inputs/available
The response will contain all available inputs.
Parse the response to identify the input you want to import
{
"count": 3,
"results": [
{
"uuid": "src_EycxTnJf",
"name": "Src6",
"pool_uuid": "pool_pm68TQXE",
"pool_name": "YBN-Test",
"usable": true,
"app": "link",
"status": "active",
"redundancy": "single"
},
{
"uuid": "src_XWxCP9TH",
"name": "Src7",
"pool_uuid": "pool_pm68TQXE",
"pool_name": "YBN-Test",
"usable": true,
"app": "link",
"status": "active",
"redundancy": "single"
},
{
"uuid": " src_owyTnjIA",
"name": "Input1 shared",
"pool_uuid": "pool_pm68TQXE",
"pool_name": "YBN-Test",
"usable": true,
"app": "link",
"status": "active",
"redundancy": "single"
}
]
}
Create a shared input with the selected input uuid
POST {{ api }}/1.0/pools/{{pool_uuid}}/inputs
{
"name": "my shared input name",
"streams": [
{
"name": "stream #1",
"type": "app",
"app": {"input_uuid": " src_owyTnjIA"}
}
]
}
Where "input_uuid" corresponds to the Quortex Link input to be imported.
Conditions
Input sharing assumes that Quortex Link and Quortex Play are in the same cloud region.
You can only bind one shared input to the Link input.
Updated on: 05/12/2024
Thank you!