Cc And Transcript

This API’s task is to check for missing captions or transcripts associated with embedded videos and audio files on a webpage. It covers the following Issue IDs:

Issue ID: cr_transcript_missing

Definition

Audio-only content such as podcasts and audio recordings of speeches and press conferences are not made available by transcript.

User Impact

When transcripts are provided for audio-only content, people who are deaf or deaf-blind will have access to the information visually or through the use of electronic braille.

Recommendation

Provide a transcript for audio-only content.

Success Criterion

1.2.1 Prerecorded Audio-only and Video-only (Level A)

Related Success Criteria (if applicable):

1.2.3 Audio Description or Media Alternative (Prerecorded) (Level A)

More details can be found at Understanding Success Criterion 1.2.1.

Issue ID: cr_captions_missing

Definition

Synchronized captions are not provided for video or other multimedia content that contains audio.

User Impact

Users who are deaf or hard of hearing will not have access to important information conveyed in audio. Captions also provide an enhanced experience for users with cognitive differences such as ADHD or learning disabilities. Additionally, captions are useful in certain situations such as environments with loud background noise or situations where sound is not allowed (e.g. the library without headphones, or near a sleeping baby).

Recommendation

Provide captions for all important audio information in video and multimedia content.

Success Criterion

1.2.2 Captions (Prerecorded) (Level A)

Related Success Criteria (if applicable):

2.2.2 Pause, Stop, Hide (Level A)
1.1.1 Non-text Content (Level A)

More details can be found at Understanding Success Criterion 1.2.2.

Request

URI

POST

https://{api_host}/http://{server-ip}:{port}//crest/api/perceivable/cc-transcript

COPY

Request Body

request_body of type(s) application/json

Required

{
    "url": "string",
    "reporttype": 0
}

string

url

Required

A URL to check WCAG violations on. It should be a valid URL.

integer

reporttype

Optional

reporttype is either xpath(value: 3) or css selector(value: 4)

Responses

200

The Success response contains categories that aggregate all the Error and Alert related issues.

Returns cc_transcript_success_response of type(s) application/json

{
    "categories": {
        "error": {
            "count": 0,
            "description": "string",
            "items": {
                "cr_captions_missing": {
                    "count": 0,
                    "description": "string",
                    "id": "string",
                    "level": "string"
                },
                "cr_transcript_missing": {
                    "count": 0,
                    "description": "string",
                    "id": "string",
                    "level": "string"
                }
            }
        }
    },
    "statistics": {
        "allitemcount": 0,
        "pageurl": "string",
        "time": "number",
        "totalelements": 0,
        "totalaudios": 0,
        "totalvideos": 0
    },
    "status": {
        "httpstatuscode": 0,
        "success": "string"
    }
}

cc_transcript_categories