Skip to main content

Video Appointments


The Video Appointments screen enables real-time video consultations between doctors and patients.


This screen includes:

  • Video area - Displays participant video feeds.
  • Picture-in-picture view - Displays local or remote secondary feed.
  • Participant labels
  • Session timer
  • Control toolbar
    • Mute
    • Disable video
    • Swap camera
    • End call
    • Report issue

Access

Open the video session from:

  • Appointment List
  • Appointment Details

Session Lifecycle

The video session follows these states:

  1. Appointment is scheduled.
  2. Doctor starts the session.
  3. Permissions are validated.
  4. Waiting state displays until the patient joins.
  5. Active session begins.
  6. Session ends and updates appointment status.

Workflow

This flow starts when the video appointment screen opens.

  1. Select Start Video.
  2. Grant camera and microphone permissions.
  3. Wait for the patient to join.
  4. Use in-call controls.
  5. End the session.

Validations

These rules enforce session readiness and capability constraints.

ScenarioApp behaviorSDK output
Camera or microphone permission missing.Block session start and display guidance.Permission validation error.
Permission prompt dismissed.Remain in non-connected state.No session initialization.
Device does not support camera switching.Hide Swap camera.Capability flag disables feature.
Network quality below threshold.Prevent connection.Session start failure response.
Session inactive beyond timeout.Disconnect session and exit.Session timeout event emitted.

Actions

ScenarioApp behaviorSDK output
Video session started.Initialize video room and enter waiting state.Session initialization event.
Microphone toggled.Update audio state.Audio state updated and synchronized.
Video toggled.Enable or disable camera stream.Video state updated.
Camera switched.Change active camera on supported devices.Camera source updated.
Call ended.Terminate session and return to previous flow.Session end event emitted.
Issue reporting opened.Open report form with session context.Report flow initialized.

Endpoint Resources

Present Video Room

PUT 

/appointments/{appointment-id}/video-room

Produces the video room screen for the specified appointment.

UI Element Types

LevelReferenceTypeValuePlacement
1start-callButtonStart call.
1end-callLinkEnd call.~
1report-issueLinkReport issue.~
1spacerSpacer~
1swap-cameraLinkSwap camera.~
1disable-videoLinkDisable video.~
1muteLinkMute.~