Utilização

Configure a component-owned voice recorder.

Este tipo é usado por audio.recorder

tsx
// Configure a component-owned voice recorder.
import { Button, audio, type RecordingFormat, type RecordingQuality } from 'kuito';

export function Memo() {
  const format: RecordingFormat = 'aac';
  const quality: RecordingQuality = 'high';
  const recorder = audio.recorder({ format, quality });
  return <Button onPress={() => void recorder.start().catch(console.error)}>Record</Button>;
}
// Declare microphone permission; finish the file with recorder.stop().

Declaração do tipo

ts
export type AudioRecorderOptions = ScopeOptions & {
  /** Defaults to `'aac'`. */
  format?: RecordingFormat;
  /** Sample rate, channels and bit rate (docs/audio.md). Defaults to `'high'`. */
  quality?: RecordingQuality;
  /** Measures the input level into `level`. Defaults to false. */
  metering?: boolean;
};

Membros 4

NomeTipoObrigatórioDescrição
scopetypeof appModuleNão—
formatFormatNãoDefaults to 'aac'.
qualityQualityNãoSample rate, channels and bit rate (docs/audio.md). Defaults to 'high'.
meteringbooleanNãoMeasures the input level into level. Defaults to false.
scope — campos aninhados

scope campos

NomeTipoObrigatórioDescrição
watch<E extends keyof Events>(event: E, listener: Events[E]) => EventSubscriptionSimCalls listener when the system warns that memory runs low. In a component it stops when the component unmounts; elsewhere the returned subscription stops it.
stateReadonlySignal<State>SimWhether the app is in the foreground. Watched, it follows the platform; starting to observe reports the state the platform starts from, which catches a change made in between.
Predefinição: AppStateModule.state
openSettings() => Promise<void>SimOpens this app's page in the system Settings.
Predefinição: AppStateModule.openSettings
watch — assinaturas de método

Assinaturas

ts
<E extends keyof Events>(event: E, listener: Events[E]): EventSubscription

Parâmetros de tipo

NomeRestriçãoPredefinição
E"memoryWarning"—

Parâmetros

NomeTipoObrigatórioDescrição
eventESim—
listenerEvents[E]Sim—

Devolve

EventSubscription

openSettings — assinaturas de método

Assinaturas

ts
(): Promise<void>

Parâmetros

Sem parâmetros.

Devolve

Promise<void>

Gerado a partir das declarações TypeScript públicas: assinaturas, props e predefinições vêm da fonte verificada, as descrições da sua JSDoc. Nenhuma predefinição é inventada.