voicebot-react-native-expo
Version:
This is a voicebot-react-native package of Kipps AI voice bot for React Native Expo
25 lines • 1.21 kB
TypeScript
import { ToggleSource } from '@livekit/components-core';
import { TrackToggleProps } from '../components';
import * as React from 'react';
/** @public */
export interface UseTrackToggleProps<T extends ToggleSource> extends Omit<TrackToggleProps<T>, 'showIcon'> {
}
/**
* The `useTrackToggle` hook is used to implement the `TrackToggle` component and returns state
* and functionality of the given track.
*
* @example
* ```tsx
* const { buttonProps, enabled } = useTrackToggle(trackRef);
* return <button {...buttonProps}>{enabled ? 'disable' : 'enable'}</button>;
* ```
* @public
*/
export declare function useTrackToggle<T extends ToggleSource>({ source, onChange, initialState, captureOptions, publishOptions, onDeviceError, ...rest }: UseTrackToggleProps<T>): {
toggle: ((forceState?: boolean) => Promise<void>) | ((forceState?: boolean, captureOptions?: import('@livekit/components-core').CaptureOptionsBySource<T> | undefined) => Promise<boolean | undefined>);
enabled: boolean;
pending: boolean;
track: import('livekit-client').LocalTrackPublication | undefined;
buttonProps: React.ButtonHTMLAttributes<HTMLButtonElement>;
};
//# sourceMappingURL=useTrackToggle.d.ts.map