Video endpoint's main entry point. More...
#import <ZDKVideoEndpointControl.h>
Instance Methods | |
| (id< ZDKResult >) | - setFormat:height:fps: |
| Configures the used video format. More... | |
| (id< ZDKResult >) | - setBitrate: |
| Configures the video encoder's bitrate. More... | |
| (id< ZDKResult >) | - startCapture: |
| Starts the video capture. More... | |
| (id< ZDKResult >) | - stopCapture |
| Stops the video capture. More... | |
| (id< ZDKResult >) | - toggleCamera |
| Toggles the camera. More... | |
| (id< ZDKResult >) | - restartCamera |
| Restarts the camera. More... | |
| (ZDKCameraSensorLocation) | - getCameraLocation |
| Gets the used camera location. More... | |
| (NSString *) | - handlesDescription |
 Instance Methods inherited from <ZDKZHandle> | |
| (long int) | - handle |
| (void) | - initialize |
| (void) | - releaseReference |
| (NSString *) | - handlesDescription |
Detailed Description
Video endpoint's main entry point.
Entry point for controlling the video endpoint
Method Documentation
◆ getCameraLocation
| - (ZDKCameraSensorLocation) getCameraLocation |
Gets the used camera location.
Not implemented!
- Returns
- The camera location
- See also
- CameraSensorLocation
◆ handlesDescription
| - (NSString *) handlesDescription |
Reimplemented from <ZDKZHandle>.
◆ restartCamera
| - (id< ZDKResult >) restartCamera |
◆ setBitrate:
| - (id< ZDKResult >) setBitrate: | (int) | value |
Configures the video encoder's bitrate.
Configures the video encoder's output bitrate in bits per second. This function along with setFormat() will affect all video calls. Because the frames come outside of this library if the frame rate is not as configured the resulting bit rate can differ greatly. Example: if the library's video encoder is configured for 128000 bps for a video format of 352x288 and 5 fps, but the frames actually come at 10fps the resulting bitrate will be 256000 bps.
- Parameters
-
[in] value The bitrate of the encoder in bits per second
- Returns
- Result of the invocation
- See also
- ZDKResult, setFormat()
◆ setFormat:height:fps:
| - (id< ZDKResult >) setFormat: | (int) | width | |
| height: | (int) | height | |
| fps: | (float) | fps | |
Configures the used video format.
Configures the format used for negotiating video calls and actual camera capture/sending.
Most codecs have limitations regarding the frame dimensions. CIF formats are always supported.
When the format is negotiated with remote peer, the zdkCallEventsHandler.onVideoFormatSelected() callback will be called.
- Parameters
-
[in] width Width of the video frame in pixels [in] height Height of the video frame in pixels [in] fps Frames per second of the video stream
- Returns
- Result of the invocation
- See also
- ZDKResult, setBitrate(), onVideoFormatSelected()
◆ startCapture:
| - (id< ZDKResult >) startCapture: | (BOOL) | hwdAcceleration |
Starts the video capture.
Not implemented!
- Parameters
-
[in] hwdAcceleration Indicator whether the hardware accelerator to be used if available
- Returns
- Result of the invocation
- See also
- ZDKResult
◆ stopCapture
| - (id< ZDKResult >) stopCapture |
◆ toggleCamera
| - (id< ZDKResult >) toggleCamera |
The documentation for this protocol was generated from the following file:
- Controllers/ZDKVideoEndpointControl.h
