Class PreJoinPage

Fileoverview

PreJoinPage component for handling room creation and joining on MediaSFU.

Component

Selector

app-pre-join-page

Standalone

true

Template Url

./pre-join-page.component.html

Style Urls

./pre-join-page.component.css

Imports

[CommonModule, ReactiveFormsModule]

Description

This component provides functionality for users to create or join a room on MediaSFU. It includes form validation, error handling, and API requests to the MediaSFU service.

Param: fb

FormBuilder service for creating form groups.

Param: http

HttpClient service for making HTTP requests.

Param: cookieService

CookieService for managing cookies.

Method

ngOnInit

Description

Lifecycle hook that is called after data-bound properties are initialized.

Method

toggleMode

Description

Toggles between create and join modes and resets the error message.

Method

handleCreateRoom

Description

Handles the creation of a room on MediaSFU. Validates form inputs, sends a request to create a room, and handles the response.

Method

handleJoinRoom

Description

Handles joining a room on MediaSFU. Validates form inputs, sends a request to join a room, and handles the response.

Method

checkLimitsAndMakeRequest

Description

Checks rate limits and makes a request to connect to a room. Handles unsuccessful attempts and updates the state accordingly.

Method

createRoomOnMediaSFU

Description

Sends a request to create a room on MediaSFU.

Param: params

Parameters for the request.

Param: params.payload

Payload for the request.

Param: params.apiUserName

API username.

Param: params.apiKey

API key.

Returns

Response from the API.

Method

joinRoomOnMediaSFU

Description

Sends a request to join a room on MediaSFU.

Param: params

Parameters for the request.

Param: params.payload

Payload for the request.

Param: params.apiUserName

API username.

Param: params.apiKey

API key.

Returns

Response from the API.

Example

<app-pre-join-page
  [parameters]="preJoinPageParameters"
  [credentials]="{ apiUserName: 'username', apiKey: 'apiKey' }"
  [localLink]="'http://localhost:3000'"
  [connectMediaSFU]="false"
></app-pre-join-page>

Implements

OnInit

Constructors

constructor

new PreJoinPage(fb, injectedParameters, injectedCredentials, injectedLocalLink, injectedConnectMediaSFU, injectedReturnUI, injectedNoUIPreJoinOptions, injectedCreateMediaSFURoom, injectedJoinMediaSFURoom, checkLimitsService, createRoomService, joinRoomService): PreJoinPage
Parameters
- fb: FormBuilder
- injectedParameters: PreJoinPageParameters
- injectedCredentials: Credentials
- injectedLocalLink: string
- injectedConnectMediaSFU: boolean
- injectedReturnUI: boolean
- injectedNoUIPreJoinOptions: CreateMediaSFURoomOptions | JoinMediaSFURoomOptions
- injectedCreateMediaSFURoom: CreateRoomOnMediaSFUType
- injectedJoinMediaSFURoom: JoinRoomOnMediaSFUType
- checkLimitsService: CheckLimitsAndMakeRequest
- createRoomService: CreateRoomOnMediaSFU
- joinRoomService: JoinRoomOnMediaSFU
Returns PreJoinPage
- Defined in src/lib/components/misc-components/pre-join-page/pre-join-page.component.ts:190

Methods

ngOnInit

ngOnInit(): void
A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

Returns void
Implementation of OnInit.ngOnInit
- Defined in src/lib/components/misc-components/pre-join-page/pre-join-page.component.ts:224

roomCreator

roomCreator(options): Promise<any>
Parameters
- options: {
      payload: any;
      apiUserName: string;
      apiKey: string;
      validate?: boolean;
  }
  - payload: any
  - apiUserName: string
  - apiKey: string
  - Optionalvalidate?: boolean
Returns Promise<any>
- Defined in src/lib/components/misc-components/pre-join-page/pre-join-page.component.ts:316

handleCreateRoom

handleCreateRoom(): Promise<void>
Returns Promise<void>
- Defined in src/lib/components/misc-components/pre-join-page/pre-join-page.component.ts:350

handleJoinRoom

handleJoinRoom(): Promise<void>
Returns Promise<void>
- Defined in src/lib/components/misc-components/pre-join-page/pre-join-page.component.ts:468

Properties

parameters

parameters: PreJoinPageParameters = ...

Input parameters for the component.

credentials

credentials: Credentials = ...

API credentials for MediaSFU.

localLink

localLink: undefined | string = ""

connectMediaSFU

connectMediaSFU: undefined | boolean = true

`Optional`returnUI

returnUI?: boolean

`Optional`noUIPreJoinOptions

noUIPreJoinOptions?: CreateMediaSFURoomOptions | JoinMediaSFURoomOptions

`Optional`createMediaSFURoom

createMediaSFURoom?: CreateRoomOnMediaSFUType

`Optional`joinMediaSFURoom

joinMediaSFURoom?: JoinRoomOnMediaSFUType

isCreateMode

isCreateMode: boolean = false

Flag to toggle between create and join modes.

preJoinForm

preJoinForm: FormGroup<any>

Form group for pre-join form.

error

error: string = ''

Error message to display.

imgSrc

imgSrc: string = ...

localConnected

localConnected: boolean = false

localData

localData: undefined | ResponseLocalConnectionData = undefined

initSocket

initSocket: undefined | Socket<DefaultEventsMap, DefaultEventsMap> = undefined

pending

pending: BehaviorSubject<boolean> = ...

Class PreJoinPage

Fileoverview

Component

Selector

Standalone

Template Url

Style Urls

Imports

Description

Param: fb

Param: http

Param: cookieService

Method

Description

Method

Description

Method

Description

Method

Description

Method

Description

Method

Description

Param: params

Param: params.payload

Param: params.apiUserName

Param: params.apiKey

Returns

Method

Description

Param: params

Param: params.payload

Param: params.apiUserName

Param: params.apiKey

Returns

Example

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns PreJoinPage

Methods

ngOnInit

Returns void

toggleMode

Returns void

joinLocalRoom

Parameters

Returns Promise<void>

createLocalRoom

Parameters

Returns Promise<void>

roomCreator

Parameters

payload: any

apiUserName: string

apiKey: string

Optionalvalidate?: boolean

Returns Promise<any>

handleCreateRoom

Returns Promise<void>

handleJoinRoom

Returns Promise<void>

Properties

parameters

credentials

localLink

connectMediaSFU

OptionalreturnUI

OptionalnoUIPreJoinOptions

OptionalcreateMediaSFURoom

OptionaljoinMediaSFURoom

isCreateMode

preJoinForm

error

`Optional`validate?: boolean

`Optional`returnUI

`Optional`noUIPreJoinOptions

`Optional`createMediaSFURoom

`Optional`joinMediaSFURoom