ZegoMixerImageInfo Class Reference
Inherits from | NSObject |
---|---|
Declared in | ZegoExpressDefines.h |
Overview
Available since: 2.19.0
Description: Sets a picture for the content of a single input stream, which is used in place of the video, i.e. the video is not displayed when the picture is used. The layout
layout in [ZegoMixerInput] for image multiplexing.
Use case: The developer needs to temporarily turn off the camera to display the image during the video connection to the microphone, or display the picture when the audio is connected to the microphone.
Restrictions: Image size is limited to 1M.
url
The image path, if not empty, the image will be displayed, otherwise, the video will be displayed. JPG and PNG formats are supported. There are 2 ways to use it: 1. URI: Provide the picture to ZEGO technical support for configuration. After the configuration is complete, the picture URI will be provided, for example: preset-id://xxx.jpg. 2. URL: Only HTTP protocol is supported.
@property (nonatomic, copy) NSString *url
Declared In
ZegoExpressDefines.h
displayMode
Image display mode. 0: Default. Use image to replace video content when url is not null. 1: Display image based on camera status. Display image when camera is turned off. Display video content when camera is turned on (no need to clear the url parameter). 2: Display image based on the input stream is empty or not. Display image when the input stream is empty for 3 consecutive seconds. The default duration for determine a input stream is empty or not is 3 seconds. If you need change this setting, please contact ZEGO technical support. Display video content when the input stream has video data.On web platforms, this property does not take effect.
@property (nonatomic, assign) int displayMode
Declared In
ZegoExpressDefines.h
– initWithURL:
ZegoMixerImageInfo instance.
- (instancetype)initWithURL:(NSString *)url
Return Value
ZegoMixerImageInfo instance.
Declared In
ZegoExpressDefines.h
– initWithURLAndDisplayMode:displayMode:
ZegoMixerImageInfo instance.
- (instancetype)initWithURLAndDisplayMode:(NSString *)url displayMode:(int)displayMode
Return Value
ZegoMixerImageInfo instance.
Declared In
ZegoExpressDefines.h