NEMeetingOptions.h

浏览该文件的文档.

// Copyright (c) 2022 NetEase, Inc. All rights reserved.
// Use of this source code is governed by a MIT license that can be
// found in the LICENSE file.
 
#import <Foundation/Foundation.h>
#import "NEMeetingChatroomConfig.h"
 
@class NEMeetingMenuItem;
@class NESingleStateMenuItem;
@class NECheckableMenuItem;
@class NECloudRecordConfig;
 
NS_ASSUME_NONNULL_BEGIN
 
typedef NS_ENUM(NSInteger, NEChatMessageNotificationType) {
  NEChatMessageNotificationTypeBarrage,
  NEChatMessageNotificationTypeBubble,
  NEChatMessageNotificationTypeNoRemind,
};
 
typedef NS_ENUM(NSInteger, NEMeetingElapsedTimeDisplayType) {
  NONE,
  MEETING_ELAPSED_TIME,
  PARTICIPATION_ELAPSED_TIME,
};
 
typedef NS_ENUM(NSInteger, NEMeetingIdDisplayOption) {
 
  DISPLAY_ALL = 0,
 
  DISPLAY_LONG_ID_ONLY,
 
  DISPLAY_SHORT_ID_ONLY,
};
 
typedef NS_ENUM(NSInteger, NEMeetingWindowMode) {
  NEMeetingWindowModeGallery = 0,
 
  //    NEMeetingWindowModeScreenShare = 1,//屏幕共享模式 后续启用
 
  NEMeetingWindowModeWhiteBoard = 2
};
 
typedef NS_ENUM(NSInteger, NEAudioAINSMode) {
  NEAudioAINSModeOff = 0,
  NEAudioAINSModeNormal = 1,
  NEAudioAINSModeEnhanced = 2,
};
 
typedef NS_ENUM(NSInteger, NEAudioProfileType) {
  NEAudioProfileTypeDefault = 0,
  NEAudioProfileTypeStandard,
  NEAudioProfileTypeStandardExtend,
  NEAudioProfileTypeMiddleQuality,
  NEAudioProfileTypeMiddleQualityStereo,
  NEAudioProfileTypeHighQuality,
  NEAudioProfileTypeHighQualityStereo
};
typedef NS_ENUM(NSInteger, NEAudioScenarioType) {
  NEAudioScenarioTypeDefault = 0,
  NEAudioScenarioTypeSpeech,
  NEAudioScenarioTypeMusic,
  NEAudioScenarioTypeChatRoom,
};
 
typedef NS_ENUM(NSInteger, NEMeetingAudioOutputDevice) {
  NEMeetingAudioOutputDefault = -1,
  NEMeetingAudioOutputSpeakerPhone = 0,
  NEMeetingAudioOutputWiredHeadset,
  NEMeetingAudioOutputEarpiece,
  NEMeetingAudioOutputBluetoothHeadset,
};
 
@interface NEAudioProfile : NSObject
 
+ (NEAudioProfile *)createSpeechAudioProfile;
 
+ (NEAudioProfile *)createMusicAudioProfile;
 
@property(nonatomic, assign) NEAudioProfileType profile;
 
@property(nonatomic, assign) NEAudioScenarioType scenario;
 
@property(nonatomic, assign) BOOL enableAINS;
 
@end
 
@interface NEWindowSize : NSObject
 
@property(nonatomic, assign) double width;
@property(nonatomic, assign) double height;
 
- (instancetype)initWithWidth:(double)width height:(double)height;
 
@end
 
@interface NEMeetingWhiteboardAppConfig : NSObject
 
@property(nonatomic, assign) BOOL nosAntiLeech;
 
@property(nonatomic, assign) NSUInteger nosAntiLeechExpire;
@property(nonatomic, copy) NSString *canvasBgColor;
 
- (instancetype)initWithNosAntiLeech:(BOOL)nosAntiLeech
                  nosAntiLeechExpire:(NSUInteger)nosAntiLeechExpire;
 
@end
 
@interface NEMeetingOptions : NSObject
 
@property(nonatomic, assign) BOOL noMuteAllVideo;
 
@property(nonatomic, assign) BOOL noMuteAllAudio;
 
@property(nonatomic, assign) BOOL noVideo;
 
@property(nonatomic, assign) BOOL noAudio;
 
@property(nonatomic, assign) BOOL frontCamera;
 
@property(nonatomic, assign) NEMeetingAudioOutputDevice audioOutputDevice;
 
@property(nonatomic, assign) BOOL showMeetingTime DEPRECATED_MSG_ATTRIBUTE(
    "deprecated in 4.9.0, use meetingElapsedTimeDisplayType instead");
 
@property(nonatomic, assign) NEMeetingElapsedTimeDisplayType meetingElapsedTimeDisplayType;
 
@property(nonatomic, assign) BOOL showNameInVideo;
 
@property(nonatomic, assign) BOOL enableSpeakerSpotlight;
 
@property(nonatomic, assign) BOOL noMinimize;
 
@property(nonatomic, assign) BOOL noInvite;
 
@property(nonatomic, assign) BOOL noSip;
 
@property(nonatomic, assign) BOOL noChat;
 
@property(nonatomic, assign) BOOL noSwitchCamera;
 
@property(nonatomic, assign) BOOL enableFrontCameraMirror;
 
@property(nonatomic, assign) BOOL noSwitchAudioMode;
 
@property(nonatomic, assign) BOOL noGallery;
 
@property(nonatomic, assign) BOOL noWhiteBoard;
 
@property(nonatomic, assign) BOOL noRename;
 
@property(nonatomic, assign) BOOL noLive;
 
@property(nonatomic, assign) BOOL showMeetingRemainingTip;
 
@property(nonatomic, assign) BOOL showScreenShareUserVideo;
 
@property(nonatomic, assign) BOOL enableAudioShare;
 
@property(nonatomic, assign) BOOL showWhiteboardShareUserVideo;
 
@property(nonatomic, assign) BOOL enableTransparentWhiteboard;
 
@property(nonatomic, assign) BOOL showFloatingMicrophone;
 
@property(nonatomic, assign) BOOL showMemberTag;
 
@property(nonatomic, assign) BOOL detectMutedMic;
 
@property(nonatomic, assign) BOOL unpubAudioOnMute;
 
@property(nonatomic, assign) NEMeetingWindowMode defaultWindowMode;
 
@property(nonatomic, assign) NEMeetingIdDisplayOption meetingIdDisplayOption;
 
@property(nonatomic, strong) NSArray<NEMeetingMenuItem *> *fullToolbarMenuItems;
 
@property(nonatomic, strong) NSArray<NEMeetingMenuItem *> *fullMoreMenuItems;
 
@property(nonatomic, strong) NSArray<NEMeetingMenuItem *> *memberActionMenuItems;
 
@property(nonatomic, assign) NSInteger joinTimeout;
 
@property(nonatomic, strong) NEAudioProfile *audioProfile;
@property(nonatomic, strong) NEMeetingChatroomConfig *chatroomConfig;
 
@property(nonatomic, assign) BOOL showCloudRecordMenuItem;
 
@property(nonatomic, assign) BOOL showCloudRecordingUI;
 
@property(nonatomic, assign) BOOL showLocalRecordingUI;
 
@property(nonatomic, assign) BOOL noNotifyCenter;
 
@property(nonatomic, assign) BOOL noWebApps;
 
@property(nonatomic, assign) BOOL noCaptions;
 
@property(nonatomic, assign) BOOL noTranscription;
 
@property(nonatomic, assign) BOOL autoEnableCaptionsOnJoin;
 
@property(nonatomic, assign) NEChatMessageNotificationType chatMessageNotificationType;
 
@property(nonatomic, assign) int pluginNotifyDuration;
 
@property(nonatomic, assign) BOOL enablePictureInPicture;
 
@property(nonatomic, assign) BOOL showNotYetJoinedMembers;
 
@property(nonatomic, assign) BOOL enableDirectMemberMediaControlByHost;
 
@property(nonatomic, assign) BOOL enableLeaveTheMeetingRequiresConfirmation;
 
@property(nonatomic, assign) BOOL showHandsUp;
 
@property(nonatomic, assign) BOOL showEmojiResponse;
 
@property(nonatomic, strong) NEWindowSize *floatingWindowSize;
 
@property(nonatomic, assign) BOOL showMeetingInfo;
 
@property(nonatomic, assign) NEMeetingWhiteboardAppConfig *whiteboardAppConfig;
@end
 
@interface NEStartMeetingOptions : NEMeetingOptions
 
@property(nonatomic, assign) BOOL noCloudRecord DEPRECATED_MSG_ATTRIBUTE(
    "deprecated in 4.7.0, use cloudRecordConfig instead");
 
@property(nonatomic, strong) NECloudRecordConfig *cloudRecordConfig;
 
@property(nonatomic, assign) BOOL enableWaitingRoom;
 
@property(nonatomic, assign) BOOL enableGuestJoin;
 
@end
 
@interface NEJoinMeetingOptions : NEMeetingOptions
 
@end
 
@interface NEMeetingRealtimeRecorderOptions : NSObject
 
@end
 
NS_ASSUME_NONNULL_END