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 | NO | Payload file path for each create asset request. |
| isAbr | NO | Indicates whether it is ABR or not. true: ABR; false: CBR. |
| externalAssetIds | NO | The generated external asset ids. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | Indicates whether ingest 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; |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | Bulk create result. |
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 |
| id | NO | Unique external identifier of the ABR asset. |
| name | NO | The display name of the created ABR asset. |
| input_directory | NO | The path URI to the entire ABR asset. |
| playout_profile | NO | ¡°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. |
| abr_layers | NO | This option allows to ingest ABR asset by providing the list of explicit URI path for each of its ABR layers. |
| package_type | NO | 0 - Not pre-packaged (default) |
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 | NO | Unique external identifier of the CBR asset |
| filename | NO | The path URI to the CBR/ABR asset. |
| name | NO | The display name of the created CBR/ABR asset. If isn't specified the name of the source file will be used. |
| abr_layers | NO | 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 | 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. |
| playout_profile | NO | ¡°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 | NO | 0 - Not pre-packaged (default) 2 SMOOTH 3 DASH (*) |
| create_c2 | NO | 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 |
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 |
| id | NO | Unique external identifier of the CBR asset |
| filename | NO | The path URI to the CBR asset. |
| name | NO | The display name of the created CBR asset. |
| playout_profile | NO | ¡°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 | NO | C2 is an index for caching of TV-VOD content segments in the CDN, including caching at the edge of the network. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | Indicates whether ingest sucessfully. |
delete CBR/ABR asset superstate
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| deleteType | NO | Type of delete. 0 - Forced (delete now) 1 - Error (will return an error if currently viewed) 2 - Wait (delete after all sessions playing this asset are done) For "Forced" type, call "Delete Multiple Files" API; For "Error/Wait" type, call "Single File Delete" API in loop. |
| externalAssetIdList | NO | external ID List. external ID is set while creating. |
| assetDeleteState | NO | The asset delete state, Default value '5'. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| result | Indicates whether it is 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 |
| extIdList | NO | external ID List. external ID is set while creating. |
| deleteType | NO | Type of delete. |
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 |
| id | NO | Unique external identifier of the ABR asset. |
| name | NO | The display name of the created ABR asset. If isn¡¯t specified the name of the source file will be used. |
| 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. |
| package_type | NO | 0 - Not pre-packaged (default) 2 ¨CSMOOTH 3 ¨C DASH (*) |
| abr_layers | NO | 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 | NO | ¡°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. |
| 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 |
| filename | NO | The path URI to the CBR asset. |
| name | NO | The display name of the created CBR asset. If isn¡¯t specified the source file name will be used. |
| playout_profile | NO | ¡°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. |
| payloadPath | NO | The path of generated payload |
| id | NO | Unique external identifier of the CBR asset |
| create_c2 | NO | C2 is an index for caching of TV-VOD content segments in the CDN, including caching at the edge of the network. |
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 |
| expectState | NO | The expect State |
| externalAssetIdList | NO | The external asset ids |
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 |
| © 2002 - 2016 Ericsson Television Inc. |
| All Rights Reserved. |