LiveKit
App · 20 actions
LiveKit room, participant, ingress and agent dispatch Twirp APIs.
Actions
| Action | What it does |
|---|---|
| Create agent dispatch | Create agent dispatch. |
| Create ingress | Create ingress. |
| Create room | Create room. |
| Delete agent dispatch | Delete agent dispatch. |
| Delete ingress | Delete ingress. |
| Delete room | Delete room. |
| Forward participant | Forward participant. |
| Get participant | Get participant. |
| List agent dispatches | List agent dispatches. |
| List ingress | List ingress. |
| List participants | List participants. |
| List rooms | List rooms. |
| Move participant | Move participant. |
| Mute track | Mute track. |
| Remove participant | Remove participant. |
| Send data | Send data. |
| Update ingress | Update ingress. |
| Update participant | Update participant. |
| Update room metadata | Update room metadata. |
| Update subscriptions | Update subscriptions. |
Create agent dispatch
Create agent dispatch.
Inputs
- Room
roomtextRequired - Room.
- Agent name
agent_nametextRequired - Agent name.
- Metadata
metadatatext - Metadata.
Outputs
dataobject- Api result.
Example output
{
"data": {
"agent_name": "example",
"id": "example",
"metadata": "example",
"room": "example"
}
}Create ingress
Create ingress.
Inputs
- Input type
input_typenumberRequired - Input type.One of:
0(RTMP),1(WHIP),2(URL). - Name
nametextRequired - Name.
- Room name
room_nametextRequired - Room name.
- Participant identity
participant_identitytextRequired - Participant identity.
- Participant name
participant_nametext - Participant name.
- Url
urltext - Url.
- Enable transcoding
enable_transcodingtrue/false - Enable transcoding.
Outputs
dataobject- Api result.
Example output
{
"data": {
"ingress_id": "example",
"name": "example",
"participant_identity": "example",
"room_name": "example",
"state": {},
"stream_key": "example",
"url": "example"
}
}Create room
Create room.
Inputs
- Name
nametextRequired - Name.
- Empty timeout
empty_timeoutnumber - Empty timeout.At least 0.
- Departure timeout
departure_timeoutnumber - Departure timeout.At least 0.
- Max participants
max_participantsnumber - Max participants.At least 0.
- Metadata
metadatatext - Metadata.
Outputs
dataobject- Api result.
Example output
{
"data": {
"creation_time": "example",
"metadata": "example",
"name": "example",
"num_participants": 1,
"sid": "example"
}
}Delete agent dispatch
Delete agent dispatch.
Inputs
- Room
roomtextRequired - Room.
- Dispatch id
dispatch_idtextRequired - Dispatch id.
Outputs
dataobject- Api result.
Example output
{
"data": {
"agent_name": "example",
"id": "example",
"metadata": "example",
"room": "example"
}
}Delete ingress
Delete ingress.
Inputs
- Ingress id
ingress_idtextRequired - Ingress id.
Outputs
dataobject- Api result.
Example output
{
"data": {
"ingress_id": "example",
"name": "example",
"participant_identity": "example",
"room_name": "example",
"state": {},
"stream_key": "example",
"url": "example"
}
}Delete room
Delete room.
Inputs
- Room
roomtextRequired - Room.
Outputs
dataobject- Api result.
Example output
{
"data": {}
}Forward participant
Forward participant.
Inputs
- Room
roomtextRequired - Room.
- Participant
identitytextRequired - Identity.
- Destination room
destination_roomtextRequired - Destination room.
Outputs
dataobject- Api result.
Example output
{
"data": {}
}Get participant
Get participant.
Inputs
- Room
roomtextRequired - Room.
- Participant
identitytextRequired - Identity.
Outputs
dataobject- Api result.
Example output
{
"data": {
"identity": "example",
"metadata": "example",
"name": "example",
"sid": "example",
"state": "example",
"tracks": []
}
}List agent dispatches
List agent dispatches.
Inputs
- Room
roomtextRequired - Room.
Outputs
dataobject- Api result.
Example output
{
"data": {
"agent_dispatches": []
}
}List ingress
List ingress.
Inputs
- Room name
room_nametext - Room name.
Outputs
dataobject- Api result.
Example output
{
"data": {
"items": []
}
}List participants
List participants.
Inputs
- Room
roomtextRequired - Room.
Outputs
dataobject- Api result.
Example output
{
"data": {
"participants": []
}
}List rooms
List rooms.
Inputs
- Names
nameslist - Names.
Outputs
dataobject- Api result.
Example output
{
"data": {
"rooms": []
}
}Move participant
Move participant.
Inputs
- Room
roomtextRequired - Room.
- Participant
identitytextRequired - Identity.
- Destination room
destination_roomtextRequired - Destination room.
Outputs
dataobject- Api result.
Example output
{
"data": {}
}Mute track
Mute track.
Inputs
- Room
roomtextRequired - Room.
- Participant
identitytextRequired - Identity.
- Track
track_sidtextRequired - Track sid.
- Muted
mutedtrue/falseRequired - Muted.
Outputs
dataobject- Api result.
Example output
{
"data": {
"track": {}
}
}Remove participant
Remove participant.
Inputs
- Room
roomtextRequired - Room.
- Participant
identitytextRequired - Identity.
Outputs
dataobject- Api result.
Example output
{
"data": {}
}Send data
Send data.
Inputs
- Room
roomtextRequired - Room.
- Text
texttextRequired - Text.
- Delivery mode
delivery_modenumberRequired - Kind.One of:
0(Reliable),1(Lossy). - Destination identities
destination_identitieslist - Destination identities.
- Topic
topictext - Topic.
Outputs
dataobject- Api result.
Example output
{
"data": {}
}Update ingress
Update ingress.
Inputs
- Ingress id
ingress_idtextRequired - Ingress id.
- Name
nametext - Name.
- Room name
room_nametext - Room name.
- Participant identity
participant_identitytext - Participant identity.
- Participant name
participant_nametext - Participant name.
Outputs
dataobject- Api result.
Example output
{
"data": {
"ingress_id": "example",
"name": "example",
"participant_identity": "example",
"room_name": "example",
"state": {},
"stream_key": "example",
"url": "example"
}
}Update participant
Update participant.
Inputs
- Room
roomtextRequired - Room.
- Participant
identitytextRequired - Identity.
- Name
nametext - Name.
- Metadata
metadatatext - Metadata.
- Attributes
attributesobject - Attributes.
- Permission
permissionobject - Permission.
Outputs
dataobject- Api result.
Example output
{
"data": {
"identity": "example",
"metadata": "example",
"name": "example",
"sid": "example",
"state": "example",
"tracks": []
}
}Update room metadata
Update room metadata.
Inputs
- Room
roomtextRequired - Room.
- Metadata
metadatatextRequired - Metadata.
Outputs
dataobject- Api result.
Example output
{
"data": {
"creation_time": "example",
"metadata": "example",
"name": "example",
"num_participants": 1,
"sid": "example"
}
}Update subscriptions
Update subscriptions.
Inputs
- Room
roomtextRequired - Room.
- Participant
identitytextRequired - Identity.
- Track sids
track_sidslistRequired - Track sids.
- Subscribe
subscribetrue/falseRequired - Subscribe.
Outputs
dataobject- Api result.
Example output
{
"data": {}
}