openvidu-components: Updated docs

pull/750/head
Carlos Santos 2022-10-07 13:35:59 +02:00
parent 600c3d778d
commit b489485c42
4 changed files with 21 additions and 24 deletions

View File

@ -1,4 +1,4 @@
import { Component, OnInit, Output, EventEmitter, Input, ChangeDetectionStrategy, ChangeDetectorRef } from '@angular/core'; import { ChangeDetectionStrategy, ChangeDetectorRef, Component, EventEmitter, Input, OnInit, Output } from '@angular/core';
import { Subscription } from 'rxjs'; import { Subscription } from 'rxjs';
import { OpenViduRole } from '../../../../models/participant.model'; import { OpenViduRole } from '../../../../models/participant.model';
import { RecordingInfo, RecordingStatus } from '../../../../models/recording.model'; import { RecordingInfo, RecordingStatus } from '../../../../models/recording.model';
@ -7,9 +7,6 @@ import { OpenViduAngularConfigService } from '../../../../services/config/openvi
import { ParticipantService } from '../../../../services/participant/participant.service'; import { ParticipantService } from '../../../../services/participant/participant.service';
import { RecordingService } from '../../../../services/recording/recording.service'; import { RecordingService } from '../../../../services/recording/recording.service';
/**
* @internal
*/
@Component({ @Component({
selector: 'ov-recording-activity', selector: 'ov-recording-activity',
templateUrl: './recording-activity.component.html', templateUrl: './recording-activity.component.html',
@ -40,11 +37,13 @@ export class RecordingActivityComponent implements OnInit {
*/ */
@Output() onDeleteRecordingClicked: EventEmitter<string> = new EventEmitter<string>(); @Output() onDeleteRecordingClicked: EventEmitter<string> = new EventEmitter<string>();
/** /**
* @internal * @internal
*/ */
recordingStatus: RecordingStatus = RecordingStatus.STOPPED; recordingStatus: RecordingStatus = RecordingStatus.STOPPED;
/**
* @internal
*/
oldRecordingStatus: RecordingStatus; oldRecordingStatus: RecordingStatus;
/** /**
* @internal * @internal

View File

@ -1,4 +1,4 @@
import { trigger, state, style, transition, animate } from '@angular/animations'; import { animate, style, transition, trigger } from '@angular/animations';
import { import {
AfterViewInit, AfterViewInit,
Component, Component,
@ -14,9 +14,10 @@ import {
import { OpenViduErrorName, Session } from 'openvidu-browser'; import { OpenViduErrorName, Session } from 'openvidu-browser';
import { Subscription } from 'rxjs'; import { Subscription } from 'rxjs';
import { import {
ActivitiesPanelDirective,
AdditionalPanelsDirective,
ChatPanelDirective, ChatPanelDirective,
LayoutDirective, LayoutDirective,
AdditionalPanelsDirective,
PanelDirective, PanelDirective,
ParticipantPanelItemDirective, ParticipantPanelItemDirective,
ParticipantPanelItemElementsDirective, ParticipantPanelItemElementsDirective,
@ -24,12 +25,11 @@ import {
StreamDirective, StreamDirective,
ToolbarAdditionalButtonsDirective, ToolbarAdditionalButtonsDirective,
ToolbarAdditionalPanelButtonsDirective, ToolbarAdditionalPanelButtonsDirective,
ToolbarDirective, ToolbarDirective
ActivitiesPanelDirective
} from '../../directives/template/openvidu-angular.directive'; } from '../../directives/template/openvidu-angular.directive';
import { ILogger } from '../../models/logger.model'; import { ILogger } from '../../models/logger.model';
import { OpenViduEdition } from '../../models/openvidu.model'; import { OpenViduEdition } from '../../models/openvidu.model';
import { ParticipantAbstractModel, ParticipantProperties } from '../../models/participant.model'; import { ParticipantAbstractModel } from '../../models/participant.model';
import { TokenModel } from '../../models/token.model'; import { TokenModel } from '../../models/token.model';
import { ActionService } from '../../services/action/action.service'; import { ActionService } from '../../services/action/action.service';
import { OpenViduAngularConfigService } from '../../services/config/openvidu-angular.config.service'; import { OpenViduAngularConfigService } from '../../services/config/openvidu-angular.config.service';
@ -72,7 +72,8 @@ import { TranslateService } from '../../services/translate/translate.service';
* | **streamDisplayAudioDetection** | `boolean` | {@link StreamDisplayAudioDetectionDirective} | * | **streamDisplayAudioDetection** | `boolean` | {@link StreamDisplayAudioDetectionDirective} |
* | **streamSettingsButton** | `boolean` | {@link StreamSettingsButtonDirective} | * | **streamSettingsButton** | `boolean` | {@link StreamSettingsButtonDirective} |
* | **participantPanelItemMuteButton** | `boolean` | {@link ParticipantPanelItemMuteButtonDirective} | * | **participantPanelItemMuteButton** | `boolean` | {@link ParticipantPanelItemMuteButtonDirective} |
* | **recordingActivityRecordingList** | `{@link RecordingInfo}[]` | {@link RecordingActivityRecordingListDirective} | * | **recordingActivityRecordingList** | `{@link RecordingInfo}[]` | {@link RecordingActivityRecordingsListDirective} |
* | **recordingActivityRecordingError** | `any` | {@link RecordingActivityRecordingErrorDirective} |
* *
* <p class="component-link-text"> * <p class="component-link-text">
* <span class="italic">See all {@link ApiDirectiveModule API Directives}</span> * <span class="italic">See all {@link ApiDirectiveModule API Directives}</span>

View File

@ -1,4 +1,4 @@
import { Directive, AfterViewInit, OnDestroy, Input, ElementRef } from '@angular/core'; import { AfterViewInit, Directive, ElementRef, Input, OnDestroy } from '@angular/core';
import { RecordingInfo } from '../../models/recording.model'; import { RecordingInfo } from '../../models/recording.model';
import { OpenViduAngularConfigService } from '../../services/config/openvidu-angular.config.service'; import { OpenViduAngularConfigService } from '../../services/config/openvidu-angular.config.service';
@ -30,7 +30,7 @@ export class RecordingActivityRecordingsListDirective implements AfterViewInit,
this.update(this.recordingsValue); this.update(this.recordingsValue);
} }
recordingsValue: RecordingInfo [] = []; recordingsValue: RecordingInfo[] = [];
constructor(public elementRef: ElementRef, private libService: OpenViduAngularConfigService) {} constructor(public elementRef: ElementRef, private libService: OpenViduAngularConfigService) {}
@ -41,8 +41,8 @@ export class RecordingActivityRecordingsListDirective implements AfterViewInit,
this.clear(); this.clear();
} }
clear() { clear() {
this.recordingsValue = null; this.recordingsValue = [];
this.update(null); this.update([]);
} }
update(value: RecordingInfo[]) { update(value: RecordingInfo[]) {
@ -67,7 +67,7 @@ export class RecordingActivityRecordingsListDirective implements AfterViewInit,
* @example * @example
* <ov-recording-activity [recordingError]="error"></ov-recording-activity> * <ov-recording-activity [recordingError]="error"></ov-recording-activity>
*/ */
@Directive({ @Directive({
selector: 'ov-videoconference[recordingActivityRecordingError], ov-recording-activity[recordingError]' selector: 'ov-videoconference[recordingActivityRecordingError], ov-recording-activity[recordingError]'
}) })
export class RecordingActivityRecordingErrorDirective implements AfterViewInit, OnDestroy { export class RecordingActivityRecordingErrorDirective implements AfterViewInit, OnDestroy {
@ -80,7 +80,7 @@ export class RecordingActivityRecordingErrorDirective implements AfterViewInit,
this.update(this.recordingErrorValue); this.update(this.recordingErrorValue);
} }
recordingErrorValue: RecordingInfo [] = []; recordingErrorValue: any = null;
constructor(public elementRef: ElementRef, private libService: OpenViduAngularConfigService) {} constructor(public elementRef: ElementRef, private libService: OpenViduAngularConfigService) {}

View File

@ -5,12 +5,9 @@ export enum RecordingStatus {
STOPPED = 'stopped', STOPPED = 'stopped',
FAILED = 'failed', FAILED = 'failed',
READY = 'ready' READY = 'ready'
}; }
/** export interface RecordingInfo {
* @internal
*/
export interface RecordingInfo {
status: RecordingStatus; status: RecordingStatus;
id?: string; id?: string;
name?: string; name?: string;
@ -18,5 +15,5 @@ export enum RecordingStatus {
createdAt?: number; createdAt?: number;
duration?: number; duration?: number;
size?: string; size?: string;
url?: string url?: string;
} }