Time Point Screencapturing Completion

Last updated: 2020-03-25 15:14:16
    • This document describes the callback on v3.0. For legacy callback on v2.0, please see Legacy Callback.
    • You are recommended to gradually migrate the callback to v3.0, as the documentation for callback v2.0 will no longer be updated.

    Event Name

    CreateSnapshotByTimeOffsetComplete

    Event Description

    If the application is configured with event notification, after a time point screenshot is captured, the application backend can get an event notification through "normal callback" or "reliable callback". API The content of the event notification is the SnapshotByTimeOffsetTask2017 structure.

    Normal Callback

    If you choose the normal callback mode, the callback URL will receive an HTTP request in the following format:

    {
        "EventType":"CreateSnapshotByTimeOffsetComplete",
        "FileUploadEvent":null,
        "ProcedureStateChangeEvent":null,
        "FileDeleteEvent":null,
        "PullCompleteEvent":null,
        "EditMediaComplete":null,
        "WechatPublishComplete":null,
        "TranscodeCompleteEvent":null,
        "ConcatCompleteEvent":null,
        "ClipCompleteEvent":null,
        "CreateImageSpriteCompleteEvent":null,
        "SnapshotByTimeOffsetCompleteEvent":{
            "TaskId":"CreateSnapshotByTimeOffset-1edb7eb88a599d05abe451cfc541cfbd",
            "FileId":"14508071098244929440",
            "Definition":10,
            "SnapshotInfoSet":[
                {
                    "ErrCode":0,
                    "TimeOffset":10000,
                    "Url":"http://125676836723.vod2.myqcloud.com/xxx/xxx/1.png"
                },
                {
                    "ErrCode":0,
                    "TimeOffset":20000,
                    "Url":"http://125676836723.vod2.myqcloud.com/xxx/xxx/2.png"
                }
            ]
        }
    }

    Reliable Callback

    If you choose the reliable callback mode, after the PullEvents API is called, an HTTP response in the following format will be received.

    {
        "Response":{
            "EventSet":[
                {
                    "EventHandle":"EventHandle.N",
                    "EventType":"CreateSnapshotByTimeOffsetComplete",
                    "FileUploadEvent":null,
                    "ProcedureStateChangeEvent":null,
                    "FileDeleteEvent":null,
                    "PullCompleteEvent":null,
                    "EditMediaComplete":null,
                    "WechatPublishComplete":null,
                    "TranscodeCompleteEvent":null,
                    "ConcatCompleteEvent":null,
                    "ClipCompleteEvent":null,
                    "CreateImageSpriteCompleteEvent":null,
                    "SnapshotByTimeOffsetCompleteEvent":{
                        "TaskId":"CreateSnapshotByTimeOffset-1edb7eb88a599d05abe451cfc541cfbd",
                        "FileId":"14508071098244929440",
                        "Definition":10,
                        "SnapshotInfoSet":[
                            {
                                "ErrCode":0,
                                "TimeOffset":10000,
                                "Url":"http://125676836723.vod2.myqcloud.com/xxx/xxx/1.png"
                            },
                            {
                                "ErrCode":0,
                                "TimeOffset":20000,
                                "Url":"http://125676836723.vod2.myqcloud.com/xxx/xxx/2.png"
                            }
                        ]
                    }
                }
            ],
            "RequestId": "335bdaa3-db0e-46ce-9946-51941d9cb0f5"
        }
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help