| Streamaxia Open SDK 3.2

List of all members
AXRecorder(RecorderSettings) Category Reference

## Instance Methods
Public methods
(void) | - changeRecorderSettings:withCompletion:
Recording mode
(BOOL) | - isRecordingModeSupported:
(void) | - changeRecordingMode:withCompletion:
Camera
(BOOL) | - isCameraPresent:
(void) | - switchToCamera:withCompletion:
Torch Mode
(BOOL) | - isTorchModeSupported:
(void) | - changeTorchMode:withCompletion:
(void) | - changeTorchLevel:withCompletion:
Resolution
(BOOL) | - isFrameSizeSupported:
(BOOL) | - isResolutionSupported:
(void) | - changeVideoResolution:withCompletion:
(void) | - changeResolutionInversion:withError:
Frame Rate
(BOOL) | - isFrameRateSupported:
(void) | - changeFrameRate:withCompletion:
Key Frame Interval
(void) | - changeKeyFrameInterval:withCompletion:
Video Bitrate
(void) | - changeVideoBitrate:withCompletion:
Audio Sample Rate
(void) | - changeAudioSampleRate:withCompletion:
Video Orientation
(void) | - changeVideoOrientation:

## Method Documentation

## ◆ changeAudioSampleRate:withCompletion:()

- (void) changeAudioSampleRate: |  | (NSInteger) | audioSampleRate
withCompletion: |  | (void(^)(BOOL success, AXError *error)) | completionBlock

Change the current audio sample rate setting. It is recommended however to use 44100 Hz. The audio sample rate is not allowed to be changed while streaming.

Parameters

  audioSampleRate | The new audio sample rate.

Extends class AXRecorder.

## ◆ changeFrameRate:withCompletion:()

- (void) changeFrameRate: |  | (NSInteger) | frameRate
withCompletion: |  | (void(^)(NSInteger validFrameRate)) | completionBlock

Change the frame rate (in fps). The frame rate is allowed to be changed while streaming.

If the new frame rate is not supported, the value is clamped into the supported ranges. The new frame rate is returned in the completion block.

Parameters

  frameRate | The new frame rate.
  completionBlock | The completion block.

Extends class AXRecorder.

## ◆ changeKeyFrameInterval:withCompletion:()

- (void) changeKeyFrameInterval: |  | (NSInteger) | keyFrameInterval
withCompletion: |  | (void(^)(BOOL success, AXError *error)) | completionBlock

Change the key frame interval for the video codec. The key frame interval is not allowed to be changed while streaming.

Parameters

  keyFrameInterval | The new key frame interval (in frames).

Extends class AXRecorder.

## ◆ changeRecorderSettings:withCompletion:()

- (void) changeRecorderSettings: |  | (AXRecorderSettings *) | settings
withCompletion: |  | (void(^)(BOOL success, AXError *error)) | completionBlock

Change and apply the recorder settings. This is not allowed while streaming.

Parameters

  settings | The recorder settings.
  completionBlock | The completion block.

Extends class AXRecorder.

## ◆ changeRecordingMode:withCompletion:()

- (void) changeRecordingMode: |  | (AXRecordingMode) | recordingMode
withCompletion: |  | (void(^)(BOOL success, AXError *error)) | completionBlock

Changes the recording mode. Use this method to mute/unmute audio or to enable/disable video. Recording mode is allowed to be changed while streaming.

The completion block returns the operation result. If change was not succesfull, the error contains the reason of the failure.

Parameters

  recordingMode | The recording mode.

Extends class AXRecorder.

## ◆ changeResolutionInversion:withError:()

- (void) changeResolutionInversion: |  | (BOOL) | inverted
withError: |  | (AXError **) | error

Change resolution inversion. Set YES for portrait mode streaming, or NO for landscape.

Parameters

  inverted | The new flag indicating whether the resolution should be inverted.

Extends class AXRecorder.

## ◆ changeTorchLevel:withCompletion:()

- (void) changeTorchLevel: |  | (float) | torchLevel
withCompletion: |  | (void(^)(BOOL success, AXError *error)) | completionBlock

Changes the torch level. Valid values are between 0.0 (off) and 1.0 (full brightness). The given value is clamped in the valid interval.

If an error occured and torch level can't be set, the error info is returned in the completion block.

Parameters

  torchLevel | The torch level.
  completionBlock | The completion block.

Extends class AXRecorder.

## ◆ changeTorchMode:withCompletion:()

- (void) changeTorchMode: |  | (AXTorchMode) | torchMode
withCompletion: |  | (void(^)(BOOL success, AXError *error)) | completionBlock

Enable or disable the torch (flash light).

Parameters

  torchMode | The new value.

Extends class AXRecorder.

## ◆ changeVideoBitrate:withCompletion:()

- (void) changeVideoBitrate: |  | (NSInteger) | videoBitRate
withCompletion: |  | (void(^)(BOOL success, AXError *error)) | completionBlock

Changes the video bit rate. The value should be in bits per second (bps). The video bitrate is allowed to be changed while streaming.

Parameters

  videoBitRate | The new vide bit rate.

Extends class AXRecorder.

## ◆ changeVideoOrientation:()

- (void) changeVideoOrientation: |  | (AXVideoOrientation) | videoOrientation |

Change the current video orientation.

Parameters

  videoOrientation | The new video orientation.

Extends class AXRecorder.

## ◆ changeVideoResolution:withCompletion:()

- (void) changeVideoResolution: |  | (AXVideoFrameResolution) | resolution
withCompletion: |  | (void(^)(BOOL success, AXError *error)) | completionBlock

Change the resolution of the currently active camera. The resolution is not allowed to be changed while streaming.

If an error occured while changing the resolution, check the error for more info.

It is recommended to change only to supported resolutions. An unsupported custom resolution can be set, but the stream video quality may be degraded due to resolution conversion during the encoding and streaming.

Note* When changing the video resolution, if not using the adaptive video bit rate, it is recommended to adjust the video bit rate to the recommended settings for best quality and performance. If the video bitrate is not appropriate for the selected resolution, the video streaming quality may suffer significantly.

Parameters

  resolution | The resolution.
  completionBlock | The completion block.

Extends class AXRecorder.

## ◆ isCameraPresent:()

- (BOOL) isCameraPresent: |  | (AXCamera) | camera |

Checks if the given camera is present on the device.

Parameters

  camera | The camera.

Returns
  YES if camera is present, NO otherwise.

Extends class AXRecorder.

## ◆ isFrameRateSupported:()

- (BOOL) isFrameRateSupported: |  | (NSInteger) | frameRate |

Checks if the given frame rate is supported by the current device.

Parameters

  frameRate | The frame rate.

Returns
  YES if the frame rate is supported, NO otherwise.

Extends class AXRecorder.

## ◆ isFrameSizeSupported:()

- (BOOL) isFrameSizeSupported: |  | (AXVideoFrameResolution) | frameSize |

Determines if the current active camera supports the given frame size.

Parameters

  frameSize | The frame size.

Returns
  YES if the frame size is supported, NO otherwise.

Extends class AXRecorder.

## ◆ isRecordingModeSupported:()

- (BOOL) isRecordingModeSupported: |  | (AXRecordingMode) | recordingMode |

Check if the current recording mode is fully supported. This methods returns NO if at least one of the audio and video is required but the appropriate device has not been authorized to be used by the user.

Parameters

  recordingMode | The recording mode.

Returns
  YES if recording mode is fully supported, NO otherwise.

Extends class AXRecorder.

## ◆ isResolutionSupported:()

- (BOOL) isResolutionSupported: |  | (AXVideoFrameResolution) | resolution |

Determines if the current active camera supports the given resolution.

Parameters

  resolution | The resolution.

Returns
  YES if the resolution is supported, NO otherwise.

Extends class AXRecorder.

## ◆ isTorchModeSupported:()

- (BOOL) isTorchModeSupported: |  | (AXTorchMode) | torchMode |

Checks if the given torch mode is supported.

Parameters

  torchMode | The torch mode.

Returns
  YES if the given torch mode is supported, NO otherwise.

Extends class AXRecorder.

## ◆ switchToCamera:withCompletion:()

- (void) switchToCamera: |  | (AXCamera) | camera
withCompletion: |  | (void(^)(BOOL success, AXError *error)) | completionBlock

Switch the active camera to the desired camera. Active camera is allowed to be changed while streaming.

The operation may be succesfull or not. It may fail if the current resolution is not supported on the desired camera. Also the camera may not be available for other reasons. The success flag in the completion block indicates if the switch was done succesfully. If the switch operation fails, check the error to see the reason of the failure.

Parameters

  camera | The new camera.
  completionBlock | The completion block.

Extends class AXRecorder.

The documentation for this category was generated from the following file:

- /Users/mac/Documents/StreamaxiaSDK/Streamaxia Open SDK/StreamaxiaSDK.framework/Headers/AXRecorder+RecorderSettings.h