Fabrix Server is a content manager system
PROPERTIES
| Name | fabrix |
| System ID | fb |
| Connection String | http://[fabrix ip]:[ fabrix port], eg, http://fabrix:5929 |
| Heartbeat Connection String | http://[fabrix ip]:[ fabrix port], eg, http://fabrix:5929 |
SUPPORTED NODE
DEFINITIONS
* Indicates the message has been deprecated. Please use the replacement message(s) instead.
NODE DEFINITION
DETAILS
bulk create CBR/ABR asset superstate
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| assetPayloadList | YES | Payload file path for each create asset request. |
| isAbr | YES | Indicates whether it is ABR or not. true: ABR; false: CBR. |
| deleteType | YES | 0-force delete; 1-soft delete |
| createAssetExternalIds | YES | The external asset ids that need to be created assets. |
| deleteAssetExternalIds | YES | The external already exists asset ids. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | Indicates whether ingest sucessfully. |
| deleteAssetPayloadList | Payload file path for each need to be deleted request. |
| deleteResult | Indicates whether delete sucessfully. |
Create assets for each payload specified in the parameter assetPayloadList. User must generated the request payload before calling this API. NOTE: If the asset already exists when creation, it will delete the asset first and then re-create.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| assetPayloadList | NO | Payload file path for each create asset request. |
| isAbr | NO | true: ABR; false: CBR |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | Bulk create result. |
| deleteAssetPayloadList | The payload list of need to be deleted assets |
| createAssetExternalIds | The external id list of need to be created assets |
| deleteAssetExternalIds | The external id list of need to be deleted assets |
ingest a VOD ABR asset from any remote server into the Video Storage and Processing Platform storage grid.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| name | YES | The display name of the created ABR asset. |
| playout_profile | YES | “Playout profile” is an aggregation of device profiles that are defined in the Video Storage and Processing Platform Product management tool. The “Playout profile” defines the list of allowed device profiles that are permitted to playout this asset. |
| package_type | YES | 0 - Not pre-packaged (default) |
| sdsEncrypt | YES | When sending this parameter as 1, the VOD asset will be AES encrypted upon ingest to the storage.Default: 0 |
| manifestURI | YES | The URI to the top manifest file (m3u8) of the asset for the HLS based ingest. |
| id | NO | Unique external identifier of the ABR asset. |
| input_directory | NO | The path URI to the entire ABR asset. |
| abr_layers | YES | This option allows to ingest ABR asset by providing the list of explicit URI path for each of its ABR layers. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | Indicates whether ingest sucessfully. |
create CBR/ABR asset superstate
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| id | YES | Unique external identifier of the CBR asset |
| filename | YES | The path URI to the CBR/ABR asset. |
| name | YES | The display name of the created CBR/ABR asset. If isn't specified the name of the source file will be used. |
| abr_layers | YES | This option allows to ingest ABR asset by providing the list of explicit URI path for each of its ABR layers. Note: Use this option only if the ingest by input_directory can't be achieved and no dedicated folder per asset can be assigned. Use this vector as well for ingest of pre-packaged VOD asset by specifying all the files URIs (e.g. ism, ismv, isma) When using this option, the package_type flag must be set accordingly. |
| input_directory | YES | The path URI to the entire ABR asset. This option allows to ingest all the ABR layers of the asset that located in the provided directory. |
| playout_profile | YES | “Playout profile” is an aggregation of number of device profiles that are defined in the Video Storage and Processing Platform management tool. The “Playout profile” defines the list of allowed device profiles that are permitted to playout this asset. |
| package_type | YES | 0 - Not pre-packaged (default) 2 SMOOTH 3 DASH (*) |
| create_c2 | YES | C2 is an index for caching of TV-VOD content segments in the CDN, including caching at the edge of the network. true: enable atis c2 index creation; false: disable atis c2 index creation |
| isEncrypted | ||
| forcedBitrate | ||
| sdsEncrypt | ||
| manifestURI |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| isABR | |
| result | Indicates whether ingest sucessfully. |
ingest the CBR asset from any remote location into the Video Storage and Processing platform storage grid.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| name | YES | The display name of the created CBR asset. |
| playout_profile | YES | “Playout profile” is an aggregation of number of device profiles that are defined in the Video Storage and Processing Platform management tool. The “Playout profile” defines the list of allowed device profiles that are permitted to playout this asset. |
| create_c2 | YES | C2 is an index for caching of TV-VOD content segments in the CDN, including caching at the edge of the network. |
| forcedBitrate | YES | Valid only when create_c2 is True. When a value is set, the configured bitrate will be used and not the detected bitrate for the ATIS-C2 index file on ingest |
| isEncrypted | YES | When set to True, the content is ingested as an encrypted content without being decrypted. Default is False |
| id | NO | Unique external identifier of the CBR asset |
| filename | NO | The path URI to the CBR asset. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | Indicates whether ingest sucessfully. |
Send an HTTP Post request to delete Assets by external Id list and delete type. The delete type is option and it is "Forced" by default.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| deleteType | YES | Type of delete. |
| extIds | NO | external ID List. external ID is set while creating. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | true: Successfully inform Fabrix server to delete all assets. |
Generate Create ABR Request payload. The payload can be used for bulk create assets with message 01fb02.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| name | YES | The display name of the created ABR asset. If isn’t specified the name of the source file will be used. |
| package_type | YES | 0 - Not pre-packaged (default) 2 –SMOOTH 3 – DASH (*) |
| abr_layers | YES | This option allows to ingest ABR asset by providing the list of explicit URI path for each of its ABR layers. Note: Use this option only if the ingest by “input_directory” can’t be achieved and no dedicated folder per asset can be assigned. Use this vector as well for ingest of pre-packaged VOD asset by specifying all the files URIs (e.g. ism, ismv, isma) When using this option, the ‘package_type’ flag must be set accordingly. |
| playout_profile | YES | “Playout profile” is an aggregation of device profiles that are defined in the Video Storage and Processing Platform Product management tool. The “Playout profile” defines the list of allowed device profiles that are permitted to playout this asset. |
| manifestURI | YES | The URI to the top manifest file (m3u8) of the asset for the HLS based ingest. |
| sdsEncrypt | YES | When sending this parameter as 1, the VOD asset will be AES encrypted upon ingest to the storage.Default: 0 |
| id | NO | Unique external identifier of the ABR asset. |
| input_directory | NO | The path URI to the entire ABR asset. This option allows to ingest all the ABR layers of the asset that located in the provided directory. |
| payloadPath | NO | The path of generated payload |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | Indicates whether generate the payload successfully. |
Generate Create CBR Request payload. The payload can be used for bulk create assets with message 01fb02.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| name | YES | The display name of the created CBR asset. If isn’t specified the source file name will be used. |
| playout_profile | YES | “Playout profile” is an aggregation of number of device profiles that are defined in the Video Storage and Processing Platform management tool. The “Playout profile” defines the list of allowed device profiles that are permitted to playout this asset. |
| create_c2 | YES | C2 is an index for caching of TV-VOD content segments in the CDN, including caching at the edge of the network. |
| forcedBitrate | YES | Valid only when create_c2 is True. When a value is set, the configured bitrate will be used and not the detected bitrate for the ATIS-C2 index file on ingest |
| isEncrypted | YES | When set to True, the content is ingested as an encrypted content without being decrypted. Default is False |
| id | NO | Unique external identifier of the CBR asset |
| filename | NO | The path URI to the CBR asset. |
| payloadPath | NO | The path of generated payload |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | Indicates whether generate payload successfully. |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| url | NO | The URL to request |
| filePath | NO | The destination path of playout file to saved |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Search all assets by gaven asset ids. wait until all assets state change to expect state.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| externalAssetIdList | NO | The external asset ids |
| expectState | NO | The expect State |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Wait until all assets ingest complete
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| externalAssetIds | NO | external AssetIds for all needed created assets. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
Such incoming node will wait for the "soft delete complete" notification message
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| expired | Such parameter is indicating whether the waiting of "soft delete" is expired or not. |
| © MediaKind Inc, 2021. |
| All Rights Reserved. |