matrix-spec/data/event-schemas/schema/m.call.candidates.yaml

{
    "type": "object",
    "description": "This event is sent by callers after sending an invite and by the callee after answering. Its purpose is to give the other party additional ICE candidates to try using to communicate.",
    "allOf": [{
        "$ref": "core-event-schema/room_event.yaml"
    }],
    "properties": {
        "content": {
            "type": "object",
            "properties": {
                "call_id": {
                    "type": "string",
                    "description": "The ID of the call this event relates to."
                },
                "candidates": {
                    "type": "array",
                    "description": "Array of objects describing the candidates.",
                    "items": {
                        "type": "object",
                        "title": "Candidate",
                        "properties": {
                            "sdpMid": {
                                "type": "string",
                                "description": "The SDP media type this candidate is intended for."
                            },
                            "sdpMLineIndex": {
                                "type": "number",
                                "description": "The index of the SDP 'm' line this candidate is intended for."
                            },
                            "candidate": {
                                "type": "string",
                                "description": "The SDP 'a' line of the candidate."
                            }
                        },
                        "required": ["candidate", "sdpMLineIndex", "sdpMid"]
                    }
                },
                "version": {
                    "type": "integer",
                    "description": "The version of the VoIP specification this message adheres to. This specification is version 1. This field is a string such that experimental implementations can use non-integer versions. This field was an integer in the previous spec version and implementations must accept an integer 0."
                }
            },
            "required": ["call_id", "candidates", "version"]
        },
        "type": {
            "type": "string",
            "enum": ["m.call.candidates"]
        }
    }
}