Interface MiniAudioOptions

Interface defining the props for the MiniAudio component.

interface MiniAudioOptions {
    visible?: boolean;
    customStyle?: StyleProp<ViewStyle>;
    name: string;
    showWaveform?: boolean;
    overlayPosition?: OverlayPosition;
    barColor?: string;
    textColor?: string;
    nameTextStyling?: StyleProp<TextStyle>;
    imageSource: string;
    roundedImage?: boolean;
    imageStyle?: StyleProp<ImageStyle>;
}

Properties

visible? customStyle? name showWaveform? overlayPosition? barColor? textColor? nameTextStyling? imageSource roundedImage? imageStyle?

Properties

Optionalvisible

visible?: boolean

Determines if the component is visible.

Default

true

OptionalcustomStyle

customStyle?: StyleProp<ViewStyle>

Custom styles for the component container.

name

name: string

The name to display on the audio player.

OptionalshowWaveform

showWaveform?: boolean

Flag to show or hide the waveform animation.

Default

false

OptionaloverlayPosition

overlayPosition?: OverlayPosition

The position of the overlay on the screen.

Default

'topLeft'

OptionalbarColor

barColor?: string

The color of the waveform bars.

Default

'red'

OptionaltextColor

textColor?: string

The color of the text.

Default

'white'

OptionalnameTextStyling

nameTextStyling?: StyleProp<TextStyle>

Custom styles for the name text.

imageSource

imageSource: string

The source URI for the background image.

OptionalroundedImage

roundedImage?: boolean

Flag to determine if the background image should be rounded.

Default

false

OptionalimageStyle

imageStyle?: StyleProp<ImageStyle>

Custom styles for the background image.

Settings

Member Visibility

On This Page

Properties