react-native-camera/docs/API.md
cristianoccazinsp aa22fd1fff feat(exif): Implement writeExif for iOS, Android improvements (#2577)
* - Improve Android code so skipProcessing is not needed, the code is more in line with iOS, and is "fast" by default. This means that skipProcessing is no longer needed (nor used), and adding additional options will "slow down" the capture as expected, rather than having always a lot of processing. This shouldn't be a breaking change.

- document the writeExif option, and implement it for iOS as well.

* Release CF object which could cause a memleak
2019-11-20 00:22:08 -03:00

3.9 KiB

id title
api Work in progress

API props

[wip]

Methods

takePictureAsync()

Returns a promise with TakePictureResponse.

Method type

takePictureAsync(options?: TakePictureOptions): Promise<TakePictureResponse>;
interface TakePictureOptions {
  quality?: number;
  orientation?: keyof Orientation | OrientationNumber;
  base64?: boolean;
  exif?: boolean;
  width?: number;
  mirrorImage?: boolean;
  doNotSave?: boolean;
  pauseAfterCapture?: boolean;
  writeExif?: boolean | { [name: string]: any };

  /** Android only */
  fixOrientation?: boolean;

  /** iOS only */
  forceUpOrientation?: boolean;
}

interface TakePictureResponse {
  width: number;
  height: number;
  uri: string;
  base64?: string;
  exif?: { [name: string]: any };
  pictureOrientation: number;
  deviceOrientation: number;
}

Usage example

takePicture = async () => {
  if (this.camera) {
    const data = await this.camera.takePictureAsync();
    console.warn('takePictureResponse ', data);
  }
};

recordAsync()

Returns a promise with RecordResponse.

Method type

recordAsync(options?: RecordOptions): Promise<RecordResponse>;
interface RecordOptions {
  quality?: keyof VideoQuality;
  orientation?: keyof Orientation | OrientationNumber;
  maxDuration?: number;
  maxFileSize?: number;
  mute?: boolean;
  mirrorVideo?: boolean;
  path?: string;
  videoBitrate?: number;

  /** iOS only */
  codec?: keyof VideoCodec | VideoCodec[keyof VideoCodec];
}

interface RecordResponse {
  /** Path to the video saved on your app's cache directory. */
  uri: string;
  videoOrientation: number;
  deviceOrientation: number;
  isRecordingInterrupted: boolean;
  /** iOS only */
  codec: VideoCodec[keyof VideoCodec];
}

Usage example

takeVideo = async () => {
  if (this.camera) {
    try {
      const promise = this.camera.recordAsync(this.state.recordOptions);

      if (promise) {
        this.setState({ isRecording: true });
        const data = await promise;
        this.setState({ isRecording: false });
        console.warn('takeVideo', data);
      }
    } catch (e) {
      console.error(e);
    }
  }
};

refreshAuthorizationStatus()

Allows to make RNCamera check Permissions again and set status accordingly. Making it possible to refresh status of RNCamera after user initially rejected the permissions.

Method type

refreshAuthorizationStatus(): Promise<void>;

Usage example

/* -> {

} */

stopRecording()

Should be called after recordAsync() to make the promise be fulfilled and get the video uri.

Method type

stopRecording(): void;

Usage example

stopRecording(): void;
/* -> {

} */

pausePreview()

Pauses the preview. The preview can be resumed again by using resumePreview().

Method type

pausePreview(): void;

Usage example

/* -> {

} */

resumePreview()

Resumes the preview after pausePreview() has been called.

Method type

resumePreview(): void;

Usage example

/* -> {

} */

getAvailablePictureSizes()

Returns a promise with getAvailablePictureSizes.

Method type

getAvailablePictureSizes(): Promise<string[]>;

Usage example

/* -> {

} */

getSupportedRatiosAsync() - Android only

Android only. Returns a promise. The promise will be fulfilled with an object with an array containing strings with all camera aspect ratios supported by the device.

Method type

getSupportedRatiosAsync(): Promise<string[]>;

Usage example

/* -> {

} */

isRecording() - iOS only

iOS only. Returns a promise. The promise will be fulfilled with a boolean indicating if currently recording is started or stopped.

Method type

isRecording(): Promise<boolean>;

Usage example

const isRecording = await isRecording();
/* -> {
  isRecording = true
} */