ovok_sdk.resources.video_calls
LiveKit video calls: appointments, access and email notices.
- Stable unknown
- Release candidate since 0.1.0-rc.4
- Development since 0.1.0-dev.25+2ba84b0
LiveKit video calls: appointments, access and email notices.
VideoCallAppointmentsResource
VideoCallAppointmentsResource(http: HttpClient)Video-call appointments; access it as ovok.video_calls.appointments.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
http | HttpClient | The HTTP client scoped to the LiveKit routes. |
list()
list(params: QueryParams | None = None) -> list[Resource]List video-call appointments.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
params | QueryParams | None | None | Optional query parameters passed to the API. |
Returns
list[Resource]: The appointments.
create()
create(body: Resource) -> ResourceCreate a video-call appointment.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
body | Resource | The appointment as the API takes it. |
Returns
Resource: The created appointment.
update()
update(appointment_id: str, body: Resource) -> ResourceReplace a video-call appointment.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
appointment_id | str | The appointment ID. | |
body | Resource | The new appointment. |
Returns
Resource: The updated appointment.
VideoCallAccessResource
VideoCallAccessResource(http: HttpClient)Access to a video call's room; access it as ovok.video_calls.access.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
http | HttpClient | The HTTP client scoped to the LiveKit routes. |
permission()
permission(appointment_id: str) -> ResourceCheck whether the signed-in user may join an appointment's call.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
appointment_id | str | The appointment ID. |
Returns
Resource: The access permission.
create_guest()
create_guest(appointment_id: str, body: Resource) -> ResourceCreate guest access to an appointment's call.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
appointment_id | str | The appointment ID. | |
body | Resource | The guest as the API takes it. |
Returns
Resource: The guest access, including its token.
create_user()
create_user(appointment_id: str) -> ResourceCreate access for the signed-in user to an appointment's call.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
appointment_id | str | The appointment ID. |
Returns
Resource: The user access, including its token.
VideoCallEmailsResource
VideoCallEmailsResource(http: HttpClient)Video-call email notices; access it as ovok.video_calls.emails.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
http | HttpClient | The HTTP client scoped to the LiveKit routes. |
invite()
invite(body: Resource) -> ResourceEmail an invitation to a call.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
body | Resource | The invitation as the API takes it. |
Returns
Resource: The API's response.
update()
update(body: Resource) -> ResourceEmail a notice that a call changed.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
body | Resource | The notice as the API takes it. |
Returns
Resource: The API's response.
cancel()
cancel(body: Resource) -> ResourceEmail a notice that a call was cancelled.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
body | Resource | The notice as the API takes it. |
Returns
Resource: The API's response.
VideoCallsResource
VideoCallsResource(http: HttpClient)LiveKit video calls: appointments, room access and email notices.
Created by Ovok; access it as ovok.video_calls.
notify_active()
notify_active(appointment_id: str) -> ResourceNotify the participants that an appointment's call is active.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
appointment_id | str | The appointment ID. |
Returns
Resource: The API's response.
Last updated on