mediasfu-angular
Version:
mediasfu-angular - Angular 17/18/19 WebRTC SDK for video conferencing, webinars, broadcasts, live streaming, chat, recording, whiteboard, and AI agents. Prebuilt rooms and fully custom UIs.
624 lines (623 loc) • 21.2 kB
TypeScript
import { Injector, OnChanges, SimpleChanges, TemplateRef } from '@angular/core';
import * as i0 from "@angular/core";
export interface AudioGridOptions {
componentsToRender: {
component: any;
inputs?: any;
}[];
containerStyle?: Partial<CSSStyleDeclaration>;
customTemplate?: TemplateRef<any>;
}
export type AudioGridType = (options: AudioGridOptions) => HTMLElement;
/**
* @component AudioGrid
*
* A dynamic grid component specifically designed for rendering audio-only participants with customizable
* layout and styling. Supports full template customization for complete control over participant presentation.
*
* @description
* AudioGrid provides three levels of customization to display audio-only participants:
*
* 1. **Basic Usage**: Use the default vertical stacked layout for audio participants
* 2. **Style Customization**: Apply custom styles via `containerStyle` to modify grid appearance
* 3. **Full Template Override**: Provide a custom `ng-template` via `customTemplate` for complete control
*
* **Key Features:**
* - Dynamic rendering of audio-only participant components
* - Efficient injector caching for performance optimization
* - Automatic cache clearing on component changes to prevent memory leaks
* - Customizable container styling
* - Full template override support for custom layouts
*
* @selector app-audio-grid
* @standalone true
* @imports CommonModule
*
* @example
* Basic Usage:
* ```html
* <app-audio-grid
* [componentsToRender]="[
* { component: AudioCard, inputs: { name: 'John Doe', audioLevel: 0.8 } },
* { component: AudioCard, inputs: { name: 'Jane Smith', audioLevel: 0.5 } }
* ]">
* </app-audio-grid>
* ```
*
* @example
* Style Customization:
* ```html
* <app-audio-grid
* [componentsToRender]="audioParticipants"
* [containerStyle]="{
* display: 'flex',
* flexWrap: 'wrap',
* gap: '12px',
* padding: '20px',
* backgroundColor: '#f5f5f5',
* borderRadius: '8px'
* }">
* </app-audio-grid>
* ```
*
* @example
* Custom Template Override:
* ```typescript
* // In your component
* @Component({
* template: `
* <app-audio-grid
* [componentsToRender]="audioParticipants"
* [customTemplate]="customAudioLayout">
* </app-audio-grid>
*
* <ng-template #customAudioLayout let-gridData>
* <div class="custom-audio-grid">
* <h3>Audio Participants ({{ gridData.componentsToRender.length }})</h3>
* <div class="audio-list">
* <div *ngFor="let item of gridData.componentsToRender; let i = index"
* class="audio-item"
* [class.active]="i === activeIndex">
* <span class="index">{{ i + 1 }}</span>
* <ng-container *ngComponentOutlet="item.component; injector: createInjector(item.inputs)"></ng-container>
* </div>
* </div>
* </div>
* </ng-template>
* `
* })
* ```
*
* @input componentsToRender - Array of components with optional inputs to render in the grid
* @input containerStyle - Custom CSS styles for the grid container
* @input customTemplate - Custom ng-template for complete grid layout override
*
* @method ngOnChanges - Clears the injector cache on changes to componentsToRender
* @method createInjector - Creates and caches an injector with specific inputs for each component
* @method clearInjectorCache - Clears the cache to avoid memory leaks and ensure updated injectors
**/
export declare class AudioGrid implements OnChanges {
private injector;
componentsToRender: {
component: any;
inputs?: any;
}[];
containerStyle?: Partial<CSSStyleDeclaration>;
customTemplate?: TemplateRef<any>;
private injectorCache;
constructor(injector: Injector);
get hasRenderableItems(): boolean;
get computedContainerStyle(): {
accentColor?: string;
alignContent?: string;
alignItems?: string;
alignSelf?: string;
alignmentBaseline?: string;
all?: string;
animation?: string;
animationComposition?: string;
animationDelay?: string;
animationDirection?: string;
animationDuration?: string;
animationFillMode?: string;
animationIterationCount?: string;
animationName?: string;
animationPlayState?: string;
animationTimingFunction?: string;
appearance?: string;
aspectRatio?: string;
backdropFilter?: string;
backfaceVisibility?: string;
background?: string;
backgroundAttachment?: string;
backgroundBlendMode?: string;
backgroundClip?: string;
backgroundColor?: string;
backgroundImage?: string;
backgroundOrigin?: string;
backgroundPosition?: string;
backgroundPositionX?: string;
backgroundPositionY?: string;
backgroundRepeat?: string;
backgroundSize?: string;
baselineShift?: string;
baselineSource?: string;
blockSize?: string;
border?: string;
borderBlock?: string;
borderBlockColor?: string;
borderBlockEnd?: string;
borderBlockEndColor?: string;
borderBlockEndStyle?: string;
borderBlockEndWidth?: string;
borderBlockStart?: string;
borderBlockStartColor?: string;
borderBlockStartStyle?: string;
borderBlockStartWidth?: string;
borderBlockStyle?: string;
borderBlockWidth?: string;
borderBottom?: string;
borderBottomColor?: string;
borderBottomLeftRadius?: string;
borderBottomRightRadius?: string;
borderBottomStyle?: string;
borderBottomWidth?: string;
borderCollapse?: string;
borderColor?: string;
borderEndEndRadius?: string;
borderEndStartRadius?: string;
borderImage?: string;
borderImageOutset?: string;
borderImageRepeat?: string;
borderImageSlice?: string;
borderImageSource?: string;
borderImageWidth?: string;
borderInline?: string;
borderInlineColor?: string;
borderInlineEnd?: string;
borderInlineEndColor?: string;
borderInlineEndStyle?: string;
borderInlineEndWidth?: string;
borderInlineStart?: string;
borderInlineStartColor?: string;
borderInlineStartStyle?: string;
borderInlineStartWidth?: string;
borderInlineStyle?: string;
borderInlineWidth?: string;
borderLeft?: string;
borderLeftColor?: string;
borderLeftStyle?: string;
borderLeftWidth?: string;
borderRadius?: string;
borderRight?: string;
borderRightColor?: string;
borderRightStyle?: string;
borderRightWidth?: string;
borderSpacing?: string;
borderStartEndRadius?: string;
borderStartStartRadius?: string;
borderStyle?: string;
borderTop?: string;
borderTopColor?: string;
borderTopLeftRadius?: string;
borderTopRightRadius?: string;
borderTopStyle?: string;
borderTopWidth?: string;
borderWidth?: string;
bottom?: string;
boxShadow?: string;
boxSizing?: string;
breakAfter?: string;
breakBefore?: string;
breakInside?: string;
captionSide?: string;
caretColor?: string;
clear?: string;
clip?: string;
clipPath?: string;
clipRule?: string;
color?: string;
colorInterpolation?: string;
colorInterpolationFilters?: string;
colorScheme?: string;
columnCount?: string;
columnFill?: string;
columnGap?: string;
columnRule?: string;
columnRuleColor?: string;
columnRuleStyle?: string;
columnRuleWidth?: string;
columnSpan?: string;
columnWidth?: string;
columns?: string;
contain?: string;
containIntrinsicBlockSize?: string;
containIntrinsicHeight?: string;
containIntrinsicInlineSize?: string;
containIntrinsicSize?: string;
containIntrinsicWidth?: string;
container?: string;
containerName?: string;
containerType?: string;
content?: string;
contentVisibility?: string;
counterIncrement?: string;
counterReset?: string;
counterSet?: string;
cssFloat?: string;
cssText?: string;
cursor?: string;
cx?: string;
cy?: string;
d?: string;
direction?: string;
display: string;
dominantBaseline?: string;
emptyCells?: string;
fill?: string;
fillOpacity?: string;
fillRule?: string;
filter?: string;
flex?: string;
flexBasis?: string;
flexDirection?: string;
flexFlow?: string;
flexGrow?: string;
flexShrink?: string;
flexWrap?: string;
float?: string;
floodColor?: string;
floodOpacity?: string;
font?: string;
fontFamily?: string;
fontFeatureSettings?: string;
fontKerning?: string;
fontOpticalSizing?: string;
fontPalette?: string;
fontSize?: string;
fontSizeAdjust?: string;
fontStretch?: string;
fontStyle?: string;
fontSynthesis?: string;
fontSynthesisSmallCaps?: string;
fontSynthesisStyle?: string;
fontSynthesisWeight?: string;
fontVariant?: string;
fontVariantAlternates?: string;
fontVariantCaps?: string;
fontVariantEastAsian?: string;
fontVariantLigatures?: string;
fontVariantNumeric?: string;
fontVariantPosition?: string;
fontVariationSettings?: string;
fontWeight?: string;
forcedColorAdjust?: string;
gap: string;
grid?: string;
gridArea?: string;
gridAutoColumns?: string;
gridAutoFlow?: string;
gridAutoRows?: string;
gridColumn?: string;
gridColumnEnd?: string;
gridColumnGap?: string;
gridColumnStart?: string;
gridGap?: string;
gridRow?: string;
gridRowEnd?: string;
gridRowGap?: string;
gridRowStart?: string;
gridTemplate?: string;
gridTemplateAreas?: string;
gridTemplateColumns?: string;
gridTemplateRows?: string;
height: string;
hyphenateCharacter?: string;
hyphens?: string;
imageOrientation?: string;
imageRendering?: string;
inlineSize?: string;
inset?: string;
insetBlock?: string;
insetBlockEnd?: string;
insetBlockStart?: string;
insetInline?: string;
insetInlineEnd?: string;
insetInlineStart?: string;
isolation?: string;
justifyContent?: string;
justifyItems?: string;
justifySelf?: string;
left?: string;
length?: number;
letterSpacing?: string;
lightingColor?: string;
lineBreak?: string;
lineHeight?: string;
listStyle?: string;
listStyleImage?: string;
listStylePosition?: string;
listStyleType?: string;
margin?: string;
marginBlock?: string;
marginBlockEnd?: string;
marginBlockStart?: string;
marginBottom?: string;
marginInline?: string;
marginInlineEnd?: string;
marginInlineStart?: string;
marginLeft?: string;
marginRight?: string;
marginTop?: string;
marker?: string;
markerEnd?: string;
markerMid?: string;
markerStart?: string;
mask?: string;
maskClip?: string;
maskComposite?: string;
maskImage?: string;
maskMode?: string;
maskOrigin?: string;
maskPosition?: string;
maskRepeat?: string;
maskSize?: string;
maskType?: string;
mathDepth?: string;
mathStyle?: string;
maxBlockSize?: string;
maxHeight?: string;
maxInlineSize?: string;
maxWidth?: string;
minBlockSize?: string;
minHeight?: string;
minInlineSize?: string;
minWidth?: string;
mixBlendMode?: string;
objectFit?: string;
objectPosition?: string;
offset?: string;
offsetAnchor?: string;
offsetDistance?: string;
offsetPath?: string;
offsetPosition?: string;
offsetRotate?: string;
opacity?: string;
order?: string;
orphans?: string;
outline?: string;
outlineColor?: string;
outlineOffset?: string;
outlineStyle?: string;
outlineWidth?: string;
overflow?: string;
overflowAnchor?: string;
overflowClipMargin?: string;
overflowWrap?: string;
overflowX?: string;
overflowY?: string;
overscrollBehavior?: string;
overscrollBehaviorBlock?: string;
overscrollBehaviorInline?: string;
overscrollBehaviorX?: string;
overscrollBehaviorY?: string;
padding?: string;
paddingBlock?: string;
paddingBlockEnd?: string;
paddingBlockStart?: string;
paddingBottom?: string;
paddingInline?: string;
paddingInlineEnd?: string;
paddingInlineStart?: string;
paddingLeft?: string;
paddingRight?: string;
paddingTop?: string;
page?: string;
pageBreakAfter?: string;
pageBreakBefore?: string;
pageBreakInside?: string;
paintOrder?: string;
parentRule?: CSSRule | null;
perspective?: string;
perspectiveOrigin?: string;
placeContent?: string;
placeItems?: string;
placeSelf?: string;
pointerEvents?: string;
position?: string;
printColorAdjust?: string;
quotes?: string;
r?: string;
resize?: string;
right?: string;
rotate?: string;
rowGap?: string;
rubyPosition?: string;
rx?: string;
ry?: string;
scale?: string;
scrollBehavior?: string;
scrollMargin?: string;
scrollMarginBlock?: string;
scrollMarginBlockEnd?: string;
scrollMarginBlockStart?: string;
scrollMarginBottom?: string;
scrollMarginInline?: string;
scrollMarginInlineEnd?: string;
scrollMarginInlineStart?: string;
scrollMarginLeft?: string;
scrollMarginRight?: string;
scrollMarginTop?: string;
scrollPadding?: string;
scrollPaddingBlock?: string;
scrollPaddingBlockEnd?: string;
scrollPaddingBlockStart?: string;
scrollPaddingBottom?: string;
scrollPaddingInline?: string;
scrollPaddingInlineEnd?: string;
scrollPaddingInlineStart?: string;
scrollPaddingLeft?: string;
scrollPaddingRight?: string;
scrollPaddingTop?: string;
scrollSnapAlign?: string;
scrollSnapStop?: string;
scrollSnapType?: string;
scrollbarColor?: string;
scrollbarGutter?: string;
scrollbarWidth?: string;
shapeImageThreshold?: string;
shapeMargin?: string;
shapeOutside?: string;
shapeRendering?: string;
stopColor?: string;
stopOpacity?: string;
stroke?: string;
strokeDasharray?: string;
strokeDashoffset?: string;
strokeLinecap?: string;
strokeLinejoin?: string;
strokeMiterlimit?: string;
strokeOpacity?: string;
strokeWidth?: string;
tabSize?: string;
tableLayout?: string;
textAlign?: string;
textAlignLast?: string;
textAnchor?: string;
textCombineUpright?: string;
textDecoration?: string;
textDecorationColor?: string;
textDecorationLine?: string;
textDecorationSkipInk?: string;
textDecorationStyle?: string;
textDecorationThickness?: string;
textEmphasis?: string;
textEmphasisColor?: string;
textEmphasisPosition?: string;
textEmphasisStyle?: string;
textIndent?: string;
textOrientation?: string;
textOverflow?: string;
textRendering?: string;
textShadow?: string;
textTransform?: string;
textUnderlineOffset?: string;
textUnderlinePosition?: string;
textWrap?: string;
textWrapMode?: string;
textWrapStyle?: string;
top?: string;
touchAction?: string;
transform?: string;
transformBox?: string;
transformOrigin?: string;
transformStyle?: string;
transition?: string;
transitionBehavior?: string;
transitionDelay?: string;
transitionDuration?: string;
transitionProperty?: string;
transitionTimingFunction?: string;
translate?: string;
unicodeBidi?: string;
userSelect?: string;
vectorEffect?: string;
verticalAlign?: string;
visibility?: string;
webkitAlignContent?: string;
webkitAlignItems?: string;
webkitAlignSelf?: string;
webkitAnimation?: string;
webkitAnimationDelay?: string;
webkitAnimationDirection?: string;
webkitAnimationDuration?: string;
webkitAnimationFillMode?: string;
webkitAnimationIterationCount?: string;
webkitAnimationName?: string;
webkitAnimationPlayState?: string;
webkitAnimationTimingFunction?: string;
webkitAppearance?: string;
webkitBackfaceVisibility?: string;
webkitBackgroundClip?: string;
webkitBackgroundOrigin?: string;
webkitBackgroundSize?: string;
webkitBorderBottomLeftRadius?: string;
webkitBorderBottomRightRadius?: string;
webkitBorderRadius?: string;
webkitBorderTopLeftRadius?: string;
webkitBorderTopRightRadius?: string;
webkitBoxAlign?: string;
webkitBoxFlex?: string;
webkitBoxOrdinalGroup?: string;
webkitBoxOrient?: string;
webkitBoxPack?: string;
webkitBoxShadow?: string;
webkitBoxSizing?: string;
webkitFilter?: string;
webkitFlex?: string;
webkitFlexBasis?: string;
webkitFlexDirection?: string;
webkitFlexFlow?: string;
webkitFlexGrow?: string;
webkitFlexShrink?: string;
webkitFlexWrap?: string;
webkitJustifyContent?: string;
webkitLineClamp?: string;
webkitMask?: string;
webkitMaskBoxImage?: string;
webkitMaskBoxImageOutset?: string;
webkitMaskBoxImageRepeat?: string;
webkitMaskBoxImageSlice?: string;
webkitMaskBoxImageSource?: string;
webkitMaskBoxImageWidth?: string;
webkitMaskClip?: string;
webkitMaskComposite?: string;
webkitMaskImage?: string;
webkitMaskOrigin?: string;
webkitMaskPosition?: string;
webkitMaskRepeat?: string;
webkitMaskSize?: string;
webkitOrder?: string;
webkitPerspective?: string;
webkitPerspectiveOrigin?: string;
webkitTextFillColor?: string;
webkitTextSizeAdjust?: string;
webkitTextStroke?: string;
webkitTextStrokeColor?: string;
webkitTextStrokeWidth?: string;
webkitTransform?: string;
webkitTransformOrigin?: string;
webkitTransformStyle?: string;
webkitTransition?: string;
webkitTransitionDelay?: string;
webkitTransitionDuration?: string;
webkitTransitionProperty?: string;
webkitTransitionTimingFunction?: string;
webkitUserSelect?: string;
whiteSpace?: string;
whiteSpaceCollapse?: string;
widows?: string;
width: string;
willChange?: string;
wordBreak?: string;
wordSpacing?: string;
wordWrap?: string;
writingMode?: string;
x?: string;
y?: string;
zIndex?: string;
zoom?: string;
getPropertyPriority?: (property: string) => string;
getPropertyValue?: (property: string) => string;
item?: (index: number) => string;
removeProperty?: (property: string) => string;
setProperty?: (property: string, value: string | null, priority?: string) => void;
'z-index': string;
'flex-direction': string;
};
ngOnChanges(changes: SimpleChanges): void;
createInjector(inputs: any): Injector;
private clearInjectorCache;
static ɵfac: i0.ɵɵFactoryDeclaration<AudioGrid, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<AudioGrid, "app-audio-grid", never, { "componentsToRender": { "alias": "componentsToRender"; "required": false; }; "containerStyle": { "alias": "containerStyle"; "required": false; }; "customTemplate": { "alias": "customTemplate"; "required": false; }; }, {}, never, never, true, never>;
}