frontend.menu

This module defines the menu for the app. There are two options:

• Record Session

• About

---

frontend.menu.about

This module defines the about page of the app.

frontend.menu.about.show_about_page()

---

frontend.menu.recordingSession

This module defines the interface between the frontend and the backend for recording a session.

frontend.menu.recordingSession.create_recording_session() → Session

Creates a recording Session (for which a Patient is first created).

1. Get the details of the patient.

   • By default, you need to provide ID and Name.

   • Any other details you want to add, here’s where you need to define those attributes.

   • Display the relevant text prompt and collect the corresponding information.

   • Eg. If you want to add information about the whereabouts of the patient:

   p_place = get_text_input('Place')
   patient = Patient(p_id, p_name, p_place)            
   

2. Get the details of the session.

   • If you need the kind of info where the user must select from a list of options, you can use select_option().

   • The template is select_option(<field_name>, <field_options>).

   • Eg. If you want to add a field for the type of video being recorded:

   field_name = 'Video category'
   field_options = ['Surgery', 'Education', 'Testimonial']
   selected_category = select_option(field_name, field_options)
   session = Session(patient, department=selected_dept, category=selected_category)
   

frontend.menu.recordingSession.end_session(sessionService: SessionService)

Ends a Session

Parameters:

sessionService (SessionService) – a SessionService

frontend.menu.recordingSession.start_session(sessionService: SessionService, vlc_path: str)

Starts a Session

Parameters:

• sessionService (SessionService) – a SessionService

• vlc_path (str) – path to the VLC player executable