AvayaClientServices.Services.Conference contains all classes that belong to Conference module. For Conference module class, see AvayaClientServices.Services.Conference.Conference.
Classes
Members
-
<static, readonly> CameraControl :String
-
Determines if the chat is private or public
Type:
- String
Properties:
Name Type Default Description CAMERA_CONTROL_UPString up This describes change the position of the remote camera to UP.
CAMERA_CONTROL_DOWNString down This describes change the position of the remote camera to DOWN
CAMERA_CONTROL_RIGHTString right This describes change the position of the remote camera to RIGHT
CAMERA_CONTROL_LEFTString left This describes change the position of the remote camera to LEFT
CAMERA_CONTROL_ZOOM_INString in This describes ZOOM_IN of the remote camera
CAMERA_CONTROL_ZOOM_OUTString out This describes ZOOM_OUT of the remote camera
-
<static, readonly> ChatMessageStatus :String
-
Determines if the chat is in pending confirmed or error state
Type:
- String
Properties:
Name Type Default Description PENDINGString pending Message in pending state.
CONFIRMEDString confirmed Message successfully sent.
ERRORString error Error while sending the message.
-
<static, readonly> ChatType :String
-
Determines if the chat is private or public
Type:
- String
Properties:
Name Type Default Description PRIVATEString private This describes private chat.
PUBLICString public This describes
-
<static> ConferenceError :string
-
An enumeration of conference errors
Type:
- string
Properties:
Name Type Default Description CAPABILITY_NOT_ALLOWEDstring CAPABILITY_NOT_ALLOWED INVALID_ARGUMENTstring INVALID_ARGUMENT NETWORK_UNAVAILABLEstring NETWORK_UNAVAILABLE CONFERENCE_CONNECTION_FAILED_TO_RECOVERstring CONFERENCE_CONNECTION_FAILED_TO_RECOVER PROVIDER_UNAVAILABLEstring PROVIDER_UNAVAILABLE NOT_SUPPORTEDstring NOT_SUPPORTED
-
<static> ConferenceType :string
-
Type:
- string
Properties:
Name Type Default Description CM_CONFERENCEstring CM SCOPIA_CONFERENCEstring Scopia
-
<static, readonly> ContentFromParticipantStatus :String
-
Determines media from participant status
Type:
- String
Properties:
Name Type Default Description ACTIVEString active Content is active.
ALLOWEDString allowed Content is allowed.
NOT_ALLOWEDString notAllowed Content is not allowed.
-
<static, readonly> DialoutStatus :String
-
Determines admission responseCode
Type:
- String
Properties:
Name Type Default Description DIALINGString dialing Dial-out status is dialing.
UNAUTHORIZEDString unauthorized Dial-out is unauthorized.
FAILString fail Dial-out failed.
NOT_ADMITTEDString notAdmitted Dial-out is not admitted.
NOT_ALLOWEDString notAllowed Dial-out not allowed for this conference.
CONNECTString connect Dial-out result is connect.
BUSYString busy Dial-out result is busy.
NO_ANSWERString noAnswer Dial-out result is noAnswer.
CANCELEDString canceled Dial-out is canceled.
-
<static, readonly> DisconnectReason :String
-
Determines disconnect reason
Type:
- String
Properties:
Name Type Default Description CALL_DISCONNECTEDString callDisconnected Disconnection reason: call disconnected.
CONFERENCE_TERMINATEDString conferenceTerminated Disconnection reason: conference terminated
DISCONNECTED_BY_MODERATOR_OR_ADMINString disconnectedByModeratorOrAdmin Disconnection reason: disconnected by moderator or admin
ERRORString error Disconnection reason: error
-
<static, readonly> HandState :String
-
Determines participant's hand state
Type:
- String
Properties:
Name Type Default Description RAISEString raise Participant's hand is raised
LOWERString lower Participant's hand is lowered
-
<static, readonly> MediaFromParticipantStatus :String
-
Determines media from participant status
Type:
- String
Properties:
Name Type Default Description ACTIVEString active Media is active.
NAString na No media stream exists.
SELF_MUTEDString selfMuted Media is self muted.
MODERATOR_MUTEDString moderatorMuted Media is muted by moderator.
BOTH_MUTEDString bothMuted Media is muted by self and by moderator.
-
<static, readonly> MediaToParticipantStatus :String
-
Determines media to participant status
Type:
- String
Properties:
Name Type Default Description AVAILABLEString available Media is active.
NAString na No media stream exists.
-
<static, readonly> MediaType :String
-
Determines media type
Type:
- String
Properties:
Name Type Default Description AUDIOString audio This is audio media type.
VIDEOString video This is video media type.
-
<static, readonly> MeetingEncryptionStatus :String
-
Determines status of meeting's encryption
Type:
- String
Properties:
Name Type Default Description YESString yes Meeting is encrypted.
NOString no Meeting is not encrypted.
PARTIALString partial Meeting is partially encrypted.
-
<static, readonly> ModeratorAdmissionActions :String
-
Contains possible participant connection statuses.
Type:
- String
Properties:
Name Type Default Description ADMITString admit Admit pending participant.
REJECTString reject Reject pending participant.
-
<static, readonly> ParticipantAuthorizationStatus :String
-
Determines participant status
Type:
- String
Properties:
Name Type Default Description ACTIVEString active Participant has active status.
AUTHORIZINGString authorizing Participant has authorizing status .
-
<static, readonly> ParticipantConnectionStatus :String
-
Contains possible participant connection statuses.
Type:
- String
Properties:
Name Type Default Description CONNECTION_STATUS_UNKNOWNString CONNECTION_STATUS_UNKNOWN Connection status is unknown.
CONNECTION_STATUS_CONNECTINGString CONNECTION_STATUS_CONNECTING Participant is connecting.
CONNECTION_STATUS_CONNECTEDString CONNECTION_STATUS_CONNECTED Participant has connected.
CONNECTION_STATUS_DISCONNECTINGString CONNECTION_STATUS_DISCONNECTING Participant is disconnecting.
CONNECTION_STATUS_DISCONNECTEDString CONNECTION_STATUS_DISCONNECTED Participant has disconnected.
-
<static, readonly> ParticipantDisconnectionReason :String
-
Contains possible participant disconnection reasons.
Type:
- String
Properties:
Name Type Default Description DISCONNECT_REASON_UNKNOWNString DISCONNECT_REASON_UNKNOWN Reason of disconnection is unknown.
DISCONNECT_REASON_DEPARTEDString DISCONNECT_REASON_DEPARTED Reason: departed.
DISCONNECT_REASON_DISCONNECTED_BY_MODERATORString DISCONNECT_REASON_DISCONNECTED_BY_MODERATOR Participant has been disconnected by moderator.
-
<static, readonly> ParticipantMediaState :String
-
Contains possible participant media states.
Type:
- String
Properties:
Name Type Default Description MEDIA_STATUS_NO_MEDIAString MEDIA_STATUS_NO_MEDIA No media.
MEDIA_STATUS_INACTIVEString MEDIA_STATUS_INACTIVE Media is inactive.
MEDIA_STATUS_RECEIVE_ONLYString MEDIA_STATUS_RECEIVE_ONLY Media can be only received.
MEDIA_STATUS_SEND_ONLYString MEDIA_STATUS_SEND_ONLY Media can be only sent.
MEDIA_STATUS_SEND_RECEIVEString MEDIA_STATUS_SEND_RECEIVE Media can be both sent and received.
-
<static, readonly> ParticipantRole :String
-
Determines participant's role
Type:
- String
Properties:
Name Type Default Description MODERATORString moderator This participant is a moderator.
PARTICIPANTString participant This participant is a ordinary participant.
GUESTString guest This participant is a guest.
OPERATORString operator This participant is an operator.
RESTRICTED_PARTICIPANTString restrictedParticipant This participant has limited capabilities in an Event Conference
-
<static, readonly> RecentTalkersConfiguration
-
-
<static, readonly> RecordingStatus :String
-
Determines media type
Type:
- String
Properties:
Name Type Default Description ONString on Recording is on.
OFFString off Recording is off.
PAUSEString pause Recording is paused.
-
<static, readonly> VideoLayout :String
-
Determines media type
Type:
- String
Properties:
Name Type Default Description LAYOUT_AUTOMATICString 1 Automatic.
LAYOUT_SINGLE_SCREENString 10 Single full-screen video.
LAYOUT_DOUBLE_SCREEN_HORIZONTALString 21 Two smaller landscape videos tiled next to one another.
LAYOUT_DOUBLE_SCREEN_VERTICALString 22 Two smaller landscape videos tiled above one another.
LAYOUT_DOUBLE_SCREEN_4_TO_1String 27 Two videos next to each other, large one to the left, smaller one to the right.
LAYOUT_1_HOST_1_PIPString 28 Two videos, one full screen, the other a small video inlayed in the lower center of the screen.
LAYOUT_PYRAMID_3String 32 Three landscape videos, one above center, two tiled horizontally underneath.
LAYOUT_LANDSCAPE_PLUS_2_ASYMString 33 Three videos, one large landscape next to two smaller videos tiled one on top of the other to the right.
LAYOUT_1_HOST_2_PIPString 34 Three videos, one full screen, two inlayed in the lower center of the screen.
LAYOUT_3x1String 35 Three videos, all set horizontally in the center of the screen.
LAYOUT_2x2String 40 Four landscape videos of equal size, two in the top row, two beneath, full square.
LAYOUT_4_PYRAMIDString 41 Four videos in two rows, one large video on top, three smaller ones underneath.
LAYOUT_3_PLUS_1String 42 Four videos, one large landscape next to three smaller videos tiled one on top of the other to the right.
LAYOUT_1_HOST_3_PIPString 43 Four videos, one full screen, three inlayed in the lower center of the screen.
LAYOUT_5_PYRAMIDString 51 Five videos in two rows, one large video on top, four smaller ones underneath.
LAYOUT_1_HOST_4_PIPString 52 Five videos, one full screen, four inlayed in the lower center of the screen.
LAYOUT_5_PLUS_1String 60 Six videos, one large landscape next to two smaller videos to the right tiled one on top of the other, and three smaller videos next to each other underneath.
LAYOUT_3x2String 61 Six landscape videos of equal size arranged in two rows.
LAYOUT_6_PLUS_1_1String 75 Seven videos, one large landscape next to two smaller videos to the right tiled one on top of the other, and four smaller videos next to each other underneath.
LAYOUT_7_PLUS_1_NEWString 81 Eight videos, one large landscape next to three smaller videos to the right tiled one on top of the other, and four smaller videos next to each other underneath.
LAYOUT_4x2String 82 Eight videos of equal size arranged in two rows of four.
LAYOUT_3x3String 90 Nine videos of equal size arranged in three rows, three per row.
LAYOUT_9_PYRAMIDString 91 Nine videos, one larger on top and eight smaller ones beneath arranged in two rows of four.
LAYOUT_8_PLUS_2_1_2String 101 Ten videos where the top two quadrants contain two larger videos, while the lower two quadrants have four videos in each.
LAYOUT_4x3String 120 12 videos of equal size arranged in three rows, four per row.
LAYOUT_12_PLUS_1_1String 131 13 videos where the top left quadrant has a large video, the remaining three quadrants have four videos each.
LAYOUT_12_PLUS_1_5String 135 13 videos, one large video in the center surrounded by twelve smaller equally sized videos around the edge of the screen.
LAYOUT_4x4String 160 16 videos of the same size, arranged in four rows of four.
LAYOUT_20_PLUS_1String 210 21 videos, one large video in the center surrounded by 20 smaller equally sized videos around the edge of the screen.
LAYOUT_20_PLUS_1_LEFTString 211 21 videos, one large video in the top left corner, eight videos to the right, tiled two across, and 12 videos underneath in two rows of six.
LAYOUT_1_PLUS_27String 280 28 videos, one large video in the top left quadrant, and nine videos in each of the remaining three quadrants.
Methods
-
<static> ConferenceException(name, message)
-
Exception representing an error related to the conference.
Parameters:
Name Type Description nameAvayaClientServices.Services.Conference.ConferenceError messagestring