stream-video-android-core/io.getstream.android.video.generated.apis/ProductvideoApi

ProductvideoApi

interface ProductvideoApi

Functions

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/accept")
abstract suspend fun acceptCall(@Path(value = "type") type: String, @Path(value = "id") id: String): AcceptCallResponse

Accept Call

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/block")
abstract suspend fun blockUser(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body blockUserRequest: BlockUserRequest): BlockUserResponse

Block user on a call Block a user, preventing them from joining the call until they are unblocked.

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/feedback")
abstract suspend fun collectUserFeedback(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body collectUserFeedbackRequest: CollectUserFeedbackRequest): CollectUserFeedbackResponse

Collect user feedback

Link copied to clipboard
@POST(value = "/video/devices")
abstract suspend fun createDevice(@Body createDeviceRequest: CreateDeviceRequest): Response

Create device Adds a new device to a user, if the same device already exists the call will have no effect

Link copied to clipboard
@POST(value = "/video/guest")
abstract suspend fun createGuest(@Body createGuestRequest: CreateGuestRequest): CreateGuestResponse

Create Guest

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/delete")
abstract suspend fun deleteCall(@Path(value = "type") type: String, @Path(value = "id") id: String): DeleteCallResponse
@POST(value = "/video/call/{type}/{id}/delete")
abstract suspend fun deleteCall(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body deleteCallRequest: DeleteCallRequest): DeleteCallResponse

Delete Call

Link copied to clipboard
@DELETE(value = "/video/devices")
abstract suspend fun deleteDevice(@Query(value = "id") id: String): Response

Delete device Deletes one device

Link copied to clipboard
@DELETE(value = "/video/call/{type}/{id}/{session}/recordings/{filename}")
abstract suspend fun deleteRecording(@Path(value = "type") type: String, @Path(value = "id") id: String, @Path(value = "session") session: String, @Path(value = "filename") filename: String): DeleteRecordingResponse

Delete recording Deletes recording

Link copied to clipboard
@DELETE(value = "/video/call/{type}/{id}/{session}/transcriptions/{filename}")
abstract suspend fun deleteTranscription(@Path(value = "type") type: String, @Path(value = "id") id: String, @Path(value = "session") session: String, @Path(value = "filename") filename: String): DeleteTranscriptionResponse

Delete transcription Deletes transcription

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/mark_ended")
abstract suspend fun endCall(@Path(value = "type") type: String, @Path(value = "id") id: String): EndCallResponse

End call

Link copied to clipboard
@GET(value = "/video/call/{type}/{id}")
abstract suspend fun getCall(@Path(value = "type") type: String, @Path(value = "id") id: String, @Query(value = "connection_id") connectionId: String? = null, @Query(value = "members_limit") membersLimit: Int? = null, @Query(value = "ring") ring: Boolean? = null, @Query(value = "notify") notify: Boolean? = null, @Query(value = "video") video: Boolean? = null): GetCallResponse

Get Call

Link copied to clipboard
@GET(value = "/video/call/{type}/{id}/report")
abstract suspend fun getCallReport(@Path(value = "type") type: String, @Path(value = "id") id: String, @Query(value = "session_id") sessionId: String? = null): GetCallReportResponse

Get call report

Link copied to clipboard
@GET(value = "/video/call_stats/{call_type}/{call_id}/{session}/participant/{user}/{user_session}/details")
abstract suspend fun getCallSessionParticipantStatsDetails(@Path(value = "call_type") callType: String, @Path(value = "call_id") callId: String, @Path(value = "session") session: String, @Path(value = "user") user: String, @Path(value = "user_session") userSession: String, @Query(value = "since") since: String? = null, @Query(value = "until") until: String? = null, @Query(value = "max_points") maxPoints: Int? = null): GetCallSessionParticipantStatsDetailsResponse

Get call session participant stats details

Link copied to clipboard
@GET(value = "/video/call_stats/{call_type}/{call_id}/{session}/participants/{user}/{user_session}/timeline")
abstract suspend fun getCallSessionParticipantStatsTimeline(@Path(value = "call_type") callType: String, @Path(value = "call_id") callId: String, @Path(value = "session") session: String, @Path(value = "user") user: String, @Path(value = "user_session") userSession: String, @Query(value = "start_time") startTime: String? = null, @Query(value = "end_time") endTime: String? = null, @Query(value = "severity") severity: List<String>? = null): QueryCallSessionParticipantStatsTimelineResponse

Get participant timeline events

Link copied to clipboard
@GET(value = "/video/edges")
abstract suspend fun getEdges(): GetEdgesResponse

Get Edges Returns the list of all edges available for video calls.

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}")
abstract suspend fun getOrCreateCall(@Path(value = "type") type: String, @Path(value = "id") id: String, @Query(value = "connection_id") connectionId: String? = null): GetOrCreateCallResponse
@POST(value = "/video/call/{type}/{id}")
abstract suspend fun getOrCreateCall(@Path(value = "type") type: String, @Path(value = "id") id: String, @Query(value = "connection_id") connectionId: String? = null, @Body getOrCreateCallRequest: GetOrCreateCallRequest): GetOrCreateCallResponse

Get or create a call Gets or creates a new call

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/go_live")
abstract suspend fun goLive(@Path(value = "type") type: String, @Path(value = "id") id: String): GoLiveResponse
@POST(value = "/video/call/{type}/{id}/go_live")
abstract suspend fun goLive(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body goLiveRequest: GoLiveRequest): GoLiveResponse

Set call as live

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/join")
abstract suspend fun joinCall(@Path(value = "type") type: String, @Path(value = "id") id: String, @Query(value = "connection_id") connectionId: String? = null, @Body joinCallRequest: JoinCallRequest): JoinCallResponse

Join call Request to join a call

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/kick")
abstract suspend fun kickUser(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body kickUserRequest: KickUserRequest): KickUserResponse

Kick user from a call Kicks a user from the call. Optionally block the user from rejoining by setting block=true.

Link copied to clipboard
@GET(value = "/video/devices")
abstract suspend fun listDevices(): ListDevicesResponse

List devices Returns all available devices

Link copied to clipboard
@GET(value = "/video/call/{type}/{id}/recordings")
abstract suspend fun listRecordings(@Path(value = "type") type: String, @Path(value = "id") id: String): ListRecordingsResponse

List recordings Lists recordings

Link copied to clipboard
@GET(value = "/video/call/{type}/{id}/transcriptions")
abstract suspend fun listTranscriptions(@Path(value = "type") type: String, @Path(value = "id") id: String): ListTranscriptionsResponse

List transcriptions Lists transcriptions

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/mute_users")
abstract suspend fun muteUsers(@Path(value = "type") type: String, @Path(value = "id") id: String): MuteUsersResponse
@POST(value = "/video/call/{type}/{id}/mute_users")
abstract suspend fun muteUsers(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body muteUsersRequest: MuteUsersRequest): MuteUsersResponse

Mute users Mutes users in a call

Link copied to clipboard
@POST(value = "/video/stats")
abstract suspend fun queryAggregateCallStats(): QueryAggregateCallStatsResponse
@POST(value = "/video/stats")
abstract suspend fun queryAggregateCallStats(@Body queryAggregateCallStatsRequest: QueryAggregateCallStatsRequest): QueryAggregateCallStatsResponse

Query Aggregate call Stats

Link copied to clipboard
@POST(value = "/video/call/members")
abstract suspend fun queryCallMembers(@Body queryCallMembersRequest: QueryCallMembersRequest): QueryCallMembersResponse

Query call members Query call members with filter query

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/participants")
abstract suspend fun queryCallParticipants(@Path(value = "id") id: String, @Path(value = "type") type: String, @Query(value = "limit") limit: Int? = null): QueryCallParticipantsResponse
@POST(value = "/video/call/{type}/{id}/participants")
abstract suspend fun queryCallParticipants(@Path(value = "id") id: String, @Path(value = "type") type: String, @Query(value = "limit") limit: Int? = null, @Body queryCallParticipantsRequest: QueryCallParticipantsRequest): QueryCallParticipantsResponse

Query call participants Returns a list of participants connected to the call

Link copied to clipboard
@POST(value = "/video/calls")
abstract suspend fun queryCalls(@Query(value = "connection_id") connectionId: String? = null): QueryCallsResponse
@POST(value = "/video/calls")
abstract suspend fun queryCalls(@Query(value = "connection_id") connectionId: String? = null, @Body queryCallsRequest: QueryCallsRequest): QueryCallsResponse

Query call Query calls with filter query

Link copied to clipboard
@GET(value = "/video/call_stats/{call_type}/{call_id}/{session}/participants")
abstract suspend fun queryCallSessionParticipantStats(@Path(value = "call_type") callType: String, @Path(value = "call_id") callId: String, @Path(value = "session") session: String, @Query(value = "sort") sort: List<SortParamRequest>? = null, @Query(value = "filter_conditions") filterConditions: Map<String, Any?>? = null): QueryCallSessionParticipantStatsResponse

Query call participant statistics

Link copied to clipboard
@POST(value = "/video/call/stats")
abstract suspend fun queryCallStats(): QueryCallStatsResponse
@POST(value = "/video/call/stats")
abstract suspend fun queryCallStats(@Body queryCallStatsRequest: QueryCallStatsRequest): QueryCallStatsResponse

Query Call Stats

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/reject")
abstract suspend fun rejectCall(@Path(value = "type") type: String, @Path(value = "id") id: String): RejectCallResponse
@POST(value = "/video/call/{type}/{id}/reject")
abstract suspend fun rejectCall(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body rejectCallRequest: RejectCallRequest): RejectCallResponse

Reject Call

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/request_permission")
abstract suspend fun requestPermission(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body requestPermissionRequest: RequestPermissionRequest): RequestPermissionResponse

Request permission Request permission to perform an action

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/event")
abstract suspend fun sendCallEvent(@Path(value = "type") type: String, @Path(value = "id") id: String): SendCallEventResponse
@POST(value = "/video/call/{type}/{id}/event")
abstract suspend fun sendCallEvent(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body sendCallEventRequest: SendCallEventRequest): SendCallEventResponse

Send custom event Sends custom event to the call

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/reaction")
abstract suspend fun sendVideoReaction(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body sendReactionRequest: SendReactionRequest): SendReactionResponse

Send reaction to the call Sends reaction to the call

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/start_closed_captions")
abstract suspend fun startClosedCaptions(@Path(value = "type") type: String, @Path(value = "id") id: String): StartClosedCaptionsResponse
@POST(value = "/video/call/{type}/{id}/start_closed_captions")
abstract suspend fun startClosedCaptions(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body startClosedCaptionsRequest: StartClosedCaptionsRequest): StartClosedCaptionsResponse

Start closed captions Starts closed captions

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/start_frame_recording")
abstract suspend fun startFrameRecording(@Path(value = "type") type: String, @Path(value = "id") id: String): StartFrameRecordingResponse
@POST(value = "/video/call/{type}/{id}/start_frame_recording")
abstract suspend fun startFrameRecording(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body startFrameRecordingRequest: StartFrameRecordingRequest): StartFrameRecordingResponse

Start frame recording Starts frame by frame recording

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/start_broadcasting")
abstract suspend fun startHLSBroadcasting(@Path(value = "type") type: String, @Path(value = "id") id: String): StartHLSBroadcastingResponse

Start HLS broadcasting Starts HLS broadcasting

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/start_recording")
abstract suspend fun startRecording(@Path(value = "type") type: String, @Path(value = "id") id: String): StartRecordingResponse
@POST(value = "/video/call/{type}/{id}/start_recording")
abstract suspend fun startRecording(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body startRecordingRequest: StartRecordingRequest): StartRecordingResponse

Start recording Starts recording

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/rtmp_broadcasts")
abstract suspend fun startRTMPBroadcasts(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body startRTMPBroadcastsRequest: StartRTMPBroadcastsRequest): StartRTMPBroadcastsResponse

Start RTMP broadcasts Starts RTMP broadcasts for the provided RTMP destinations

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/start_transcription")
abstract suspend fun startTranscription(@Path(value = "type") type: String, @Path(value = "id") id: String): StartTranscriptionResponse
@POST(value = "/video/call/{type}/{id}/start_transcription")
abstract suspend fun startTranscription(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body startTranscriptionRequest: StartTranscriptionRequest): StartTranscriptionResponse

Start transcription Starts transcription

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/rtmp_broadcasts/stop")
abstract suspend fun stopAllRTMPBroadcasts(@Path(value = "type") type: String, @Path(value = "id") id: String): StopAllRTMPBroadcastsResponse

Stop all RTMP broadcasts for a call Stop all RTMP broadcasts for the provided call

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/stop_closed_captions")
abstract suspend fun stopClosedCaptions(@Path(value = "type") type: String, @Path(value = "id") id: String): StopClosedCaptionsResponse
@POST(value = "/video/call/{type}/{id}/stop_closed_captions")
abstract suspend fun stopClosedCaptions(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body stopClosedCaptionsRequest: StopClosedCaptionsRequest): StopClosedCaptionsResponse

Stop closed captions Stops closed captions

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/stop_frame_recording")
abstract suspend fun stopFrameRecording(@Path(value = "type") type: String, @Path(value = "id") id: String): StopFrameRecordingResponse

Stop frame recording Stops frame recording

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/stop_broadcasting")
abstract suspend fun stopHLSBroadcasting(@Path(value = "type") type: String, @Path(value = "id") id: String): StopHLSBroadcastingResponse

Stop HLS broadcasting Stops HLS broadcasting

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/stop_live")
abstract suspend fun stopLive(@Path(value = "type") type: String, @Path(value = "id") id: String): StopLiveResponse
@POST(value = "/video/call/{type}/{id}/stop_live")
abstract suspend fun stopLive(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body stopLiveRequest: StopLiveRequest): StopLiveResponse

Set call as not live

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/stop_recording")
abstract suspend fun stopRecording(@Path(value = "type") type: String, @Path(value = "id") id: String): StopRecordingResponse

Stop recording Stops recording

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/stop_transcription")
abstract suspend fun stopTranscription(@Path(value = "type") type: String, @Path(value = "id") id: String): StopTranscriptionResponse
@POST(value = "/video/call/{type}/{id}/stop_transcription")
abstract suspend fun stopTranscription(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body stopTranscriptionRequest: StopTranscriptionRequest): StopTranscriptionResponse

Stop transcription Stops transcription

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/unblock")
abstract suspend fun unblockUser(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body unblockUserRequest: UnblockUserRequest): UnblockUserResponse

Unblocks user on a call Removes the block for a user on a call. The user will be able to join the call again.

Link copied to clipboard
@PATCH(value = "/video/call/{type}/{id}")
abstract suspend fun updateCall(@Path(value = "type") type: String, @Path(value = "id") id: String): UpdateCallResponse
@PATCH(value = "/video/call/{type}/{id}")
abstract suspend fun updateCall(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body updateCallRequest: UpdateCallRequest): UpdateCallResponse

Update Call

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/members")
abstract suspend fun updateCallMembers(@Path(value = "type") type: String, @Path(value = "id") id: String): UpdateCallMembersResponse
@POST(value = "/video/call/{type}/{id}/members")
abstract suspend fun updateCallMembers(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body updateCallMembersRequest: UpdateCallMembersRequest): UpdateCallMembersResponse

Update Call Member

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/user_permissions")
abstract suspend fun updateUserPermissions(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body updateUserPermissionsRequest: UpdateUserPermissionsRequest): UpdateUserPermissionsResponse

Update user permissions Updates user permissions

Link copied to clipboard
@GET(value = "/video/longpoll")
abstract suspend fun videoConnect()

Video Connect (WebSocket) Establishes WebSocket connection for user to video

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/pin")
abstract suspend fun videoPin(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body pinRequest: PinRequest): PinResponse

Pin Pins a track for all users in the call.

Link copied to clipboard
@POST(value = "/video/call/{type}/{id}/unpin")
abstract suspend fun videoUnpin(@Path(value = "type") type: String, @Path(value = "id") id: String, @Body unpinRequest: UnpinRequest): UnpinResponse

Unpin Unpins a track for all users in the call.