Interface MiniCardAudioOptions

Interface defining the props for the MiniCardAudio component.

interface MiniCardAudioOptions {
    customStyle?: StyleProp<ViewStyle>;
    name: string;
    showWaveform: boolean;
    overlayPosition?: OverlayPosition;
    barColor?: string;
    textColor?: string;
    imageSource?: string;
    roundedImage?: boolean;
    imageStyle?: StyleProp<ImageStyle>;
    style?: object;
    renderContent?: ((options: {
        defaultContent: ReactNode;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
    renderContainer?: ((options: {
        defaultContainer: ReactNode;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

customStyle? name showWaveform overlayPosition? barColor? textColor? imageSource? roundedImage? imageStyle? style? renderContent? renderContainer?

Properties

OptionalcustomStyle

customStyle?: StyleProp<ViewStyle>

Custom styles to apply to the card.

name

name: string

The name to display on the card.

showWaveform

showWaveform: boolean

Flag to show or hide the waveform animation.

OptionaloverlayPosition

overlayPosition?: OverlayPosition

Position of the overlay on the card.

Default

'topLeft'

OptionalbarColor

barColor?: string

The color of the waveform bars.

Default

'white'

OptionaltextColor

textColor?: string

The color of the text.

Default

'white'

OptionalimageSource

imageSource?: string

The source URI for the background image.

OptionalroundedImage

roundedImage?: boolean

Flag to apply rounded corners to the image.

Default

false

OptionalimageStyle

imageStyle?: StyleProp<ImageStyle>

Custom styles to apply to the image.

Optionalstyle

style?: object

Optional custom style to apply to the container.

OptionalrenderContent

renderContent?: ((options: {
    defaultContent: ReactNode;
    dimensions: {
        width: number;
        height: number;
    };
}) => ReactNode)

Optional function to render custom content, receiving the default content and dimensions.

OptionalrenderContainer

renderContainer?: ((options: {
    defaultContainer: ReactNode;
    dimensions: {
        width: number;
        height: number;
    };
}) => ReactNode)

Optional function to render a custom container, receiving the default container and dimensions.

Settings

Member Visibility

On This Page

Properties