27 May 2021

Zscale Scaling Library

Added a new format parameter that allows selecting scaling library.

<?xml version="1.0"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>addMedia</action>
    <source>[SourceFile]</source> <!-- required-->
    <format> <!-- required -->
        <output>[output]</output> <!-- required -->
        <scaler_lib>[default|zscale]</scaler_lib>
        <!-- format params -->
    </format>
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "addMedia", // required
        "source": "[SourceFile]", // required
        "format": { // required
            "output": "[output]", // required
            "scaler_lib": "[default|zscale]"
            // format params
        }
    }
}

Parameter	Description	Allowed Values	Default Values
scaler_lib	Scaler library	default, zscale	default

Baton QC Prohibited Words

Adde ability to check for a specified list of prohibited words in closed captions via Baton QC.

You can create several prohibited words lists and we will check all of them in Baton Validation test.
To manage lists we provide these API requests:

Create New List

Request:

<?xml version="1.0" encoding="UTF-8"?>
<query>
    <userid><<id>></userid> <!-- required -->
    <userkey><<key>></userkey> <!-- required-->
    <action>SetBatonProfaneWords</action> <!-- required-->
    <name>[ListName]</name> <!-- required-->
    <words>
        <word>[Word_1]</word>
        <word>[Word_2]</word>
        <!-- ... -->
        <word>[Word_N]</word>
    </words>
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "SetBatonProfaneWords", // required
        "name": "[ListName]", // required
        "words": {
            "word": [
                "[Word_1]",
                "[Word_1]",
                // ...
                "[Word_N]"
            ]
        }
    }
}

Parameter	Description	Allowed Values
name	List Name	String
word	Prohibited Word	String

Response:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <action>setbatonprofanewords</action>
    <status>Success</status>
</response>

{
    "response": {
        "action": "setbatonprofanewords",
        "status": "Success"
    }
}

Show Added Lists

Request:

<?xml version="1.0" encoding="UTF-8"?>
<query>
    <userid><<id>></userid> <!-- required -->
    <userkey><<key>></userkey> <!-- required-->
    <action>ListBatonProfaneWordLists</action> <!-- required-->
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "ListBatonProfaneWords" // required
    }
}

Response:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <action>listbatonprofanewordlists</action>
    <status>Success</status>
    <result>
        <user_id><<id>></user_id>
        <wordlists>
            <wordlist>[ListName_1]</wordlist>
            <wordlist>[ListName_1]</wordlist>
            <!-- ... -->
            <wordlist>[ListName_N]</wordlist>
        </wordlists>
    </result>
</response>

{
    "response": {
        "action": "listbatonprofanewords",
        "status": "Success",
        "result": {
            "user_id": "<<id>>",
            "wordlists": {
                "wordlist": [
                    "ListName_1",
                    "ListName_2",
                    // ...
                    "ListName_N"
                ]
            }
        }
    }
}

Delete Words List

Request:

<?xml version="1.0" encoding="UTF-8"?>
<query>
    <userid><<id>></userid> <!-- required -->
    <userkey><<key>></userkey> <!-- required-->
    <action>DropBatonProfaneWords</action> <!-- required-->
    <name>[ListName]</name> <!-- required-->
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "DropBatonProfaneWords", // required
        "name": "[ListName]" // required
    }
}

Parameter	Description	Allowed Values
name	List Name	String

Response:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <action>dropbatonprofanewords</action>
    <status>Success</status>
</response>

{
    "response": {
        "action": "dropbatonprofanewords",
        "status": "Success"
    }
}

Show Words In List

Request:

<?xml version="1.0" encoding="UTF-8"?>
<query>
    <userid><<id>></userid> <!-- required -->
    <userkey><<key>></userkey> <!-- required-->
    <action>GetBatonProfaneWords</action> <!-- required-->
    <name>[ListName]</name> <!-- required-->
</query>

{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // required
        "action": "GetBatonProfaneWords", // required
        "name": "[ListName]" // required
    }
}

Parameter	Description	Allowed Values
name	List Name	String

Response:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <action>getbatonprofanewords</action>
    <status>Success</status>
    <result>
        <user_id><<id>></user_id>
        <words>
            <word>[Word_1]</word>
            <word>[Word_1]</word>
            <!-- ... -->
            <word>[Word_N]</word>
        </words>
    </result>
</response>

{
    "response": {
        "action": "getbatonprofanewords",
        "status": "Success",
        "result": {
            "user_id": "<<id>>",
            "words": {
                "word": [
                    "Word_1",
                    "Word_2",
                    // ...
                    "Word_N"
                ]
            }
        }
    }
}