Azuki

[azuki] Resource Type for Azuki device.

PROPERTIES
Name Azuki
System ID AZ
Connection String null
Heartbeat Connection String null
SUPPORTED NODE DEFINITIONS
Message UID Node Definition Name
01AZ07 Create Client Right
01AZ05 Delete
SuperState Ingest And Wait For Status
01AZ01 Ingest
01AZ04 Is Media Enabled
01AZ08 MDU Or Status Changed
01AZ03 Purge
01AZ02 Retrieve Status
01AZ06 Wait For Status

* The message has been deprecated. Please use the replacement message(s) instead.

NODE DEFINITION DETAILS
Create Client Right (01AZ07)

Calls Azuki API to create or update client right. Note that this message only create global rights.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
owner_uid NO Unique string that identifies the owner of the media and/or the owner associated with the client.
acct_group NO Primary client account group to which the client rights apply.
media_group NO Name of a media group to which the client rights apply.
media_uid NO Unique string that identifies the media to which the client rights apply. Note that do NOT use the media_uid and media_group parameters at the same time. if both of them are used, media_uid will be ignored by this message.
filepath NO The xml file path which containing the payload required to create client right.
RESPONSE MESSAGE:
Parameter Name Description / Value
result true: client right create/update successfully. false: fail to create/update the client right at azuki.
Delete (01AZ05)

Delete media from the database and CDN along with all other records.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
media_uid NO
owner_uid NO
RESPONSE MESSAGE:
Parameter Name Description / Value
uid
Ingest And Wait For Status (SuperState)

Call Azuki API to ingest asset and monitor the status of the asset on Azuki system

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
media_uid
owner_uid
status
delay
startMediaStatusValues
errorMediaStatusValues
transcodingBitrateStatusValues
mediaEnabledStatusValues
bitrateStatusValues
isResumeFromDB
filepath
oldStatus
scenario
amp_group_name
Ingest (01AZ01)

Used to ingest or update media and/or metadata.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
media_uid NO
owner_uid NO
filepath NO generate azuki ingestion metadata xml file path
amp_group_name NO MRR AMP Group Name
RESPONSE MESSAGE:
Parameter Name Description / Value
isResumeFromDB
Is Media Enabled (01AZ04)

Checks for media status until it is Enabled.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
media_uid NO
owner_uid NO
RESPONSE MESSAGE:
Parameter Name Description / Value
enabled
MDU Or Status Changed (01AZ08)

If it is Metadata update only scenario, then pass directly. Otherwise, it has to wait for the media status changed to make sure the new ingestion has been triggered(Not blocked in the queue) on Azuki.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
owner_uid NO
media_uid NO
inputStatus NO the old status before ingestion
metadataFilePath NO the path of metadata file
delay NO the period delay for getting the status each time
RESPONSE MESSAGE:
Parameter Name Description / Value
scenario MDU_SCENARIO: Metadata Update Only; STATUS_CHANGED_SCENARIO_[Old Status]_[New Status]: the media status changed.
Purge (01AZ03)

Purge media from the database.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
owner_uid NO
media_uid NO
RESPONSE MESSAGE:
Parameter Name Description / Value
uid
Retrieve Status (01AZ02)

Retrieves status after ingestion.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
media_uid NO
owner_uid NO
RESPONSE MESSAGE:
Parameter Name Description / Value
status
Wait For Status (01AZ06)

Wait for the media status to one of a list of media status values or one of the bandwidth status to change to one of a list of bandwidth status values before returning.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
media_uid NO
owner_uid NO
delay NO
mediaStatusValues NO
bitrateStatusValues NO
RESPONSE MESSAGE:
Parameter Name Description / Value
status
bitrateStatuses
© 2002 - 2012 Ericsson Television Inc.
All Rights Reserved.