Namespace: Conference

AvayaClientServices.Services.Conference contains all classes that belong to Conference module. For Conference module class, see AvayaClientServices.Services.Conference.Conference.

Classes

ActiveParticipant
Chat
ChatMessage
Conference
DroppedParticipant
Participant
PendingParticipant

Members

<static, readonly> CameraControl :String

Determines if the chat is private or public

Type:
  • String
Properties:
Name Type Default Description
CAMERA_CONTROL_UP String up

This describes change the position of the remote camera to UP.

CAMERA_CONTROL_DOWN String down

This describes change the position of the remote camera to DOWN

CAMERA_CONTROL_RIGHT String right

This describes change the position of the remote camera to RIGHT

CAMERA_CONTROL_LEFT String left

This describes change the position of the remote camera to LEFT

CAMERA_CONTROL_ZOOM_IN String in

This describes ZOOM_IN of the remote camera

CAMERA_CONTROL_ZOOM_OUT String 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
PENDING String pending

Message in pending state.

CONFIRMED String confirmed

Message successfully sent.

ERROR String 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
PRIVATE String private

This describes private chat.

PUBLIC String public

This describes

<static> ConferenceError :string

An enumeration of conference errors

Type:
  • string
Properties:
Name Type Default Description
CAPABILITY_NOT_ALLOWED string CAPABILITY_NOT_ALLOWED
INVALID_ARGUMENT string INVALID_ARGUMENT
NETWORK_UNAVAILABLE string NETWORK_UNAVAILABLE
CONFERENCE_CONNECTION_FAILED_TO_RECOVER string CONFERENCE_CONNECTION_FAILED_TO_RECOVER
PROVIDER_UNAVAILABLE string PROVIDER_UNAVAILABLE
NOT_SUPPORTED string NOT_SUPPORTED

<static> ConferenceType :string

Type:
  • string
Properties:
Name Type Default Description
CM_CONFERENCE string CM
SCOPIA_CONFERENCE string Scopia

<static, readonly> ContentFromParticipantStatus :String

Determines media from participant status

Type:
  • String
Properties:
Name Type Default Description
ACTIVE String active

Content is active.

ALLOWED String allowed

Content is allowed.

NOT_ALLOWED String notAllowed

Content is not allowed.

<static, readonly> DialoutStatus :String

Determines admission responseCode

Type:
  • String
Properties:
Name Type Default Description
DIALING String dialing

Dial-out status is dialing.

UNAUTHORIZED String unauthorized

Dial-out is unauthorized.

FAIL String fail

Dial-out failed.

NOT_ADMITTED String notAdmitted

Dial-out is not admitted.

NOT_ALLOWED String notAllowed

Dial-out not allowed for this conference.

CONNECT String connect

Dial-out result is connect.

BUSY String busy

Dial-out result is busy.

NO_ANSWER String noAnswer

Dial-out result is noAnswer.

CANCELED String canceled

Dial-out is canceled.

<static, readonly> DisconnectReason :String

Determines disconnect reason

Type:
  • String
Properties:
Name Type Default Description
CALL_DISCONNECTED String callDisconnected

Disconnection reason: call disconnected.

CONFERENCE_TERMINATED String conferenceTerminated

Disconnection reason: conference terminated

DISCONNECTED_BY_MODERATOR_OR_ADMIN String disconnectedByModeratorOrAdmin

Disconnection reason: disconnected by moderator or admin

ERROR String error

Disconnection reason: error

<static, readonly> HandState :String

Determines participant's hand state

Type:
  • String
Properties:
Name Type Default Description
RAISE String raise

Participant's hand is raised

LOWER String lower

Participant's hand is lowered

<static, readonly> MediaFromParticipantStatus :String

Determines media from participant status

Type:
  • String
Properties:
Name Type Default Description
ACTIVE String active

Media is active.

NA String na

No media stream exists.

SELF_MUTED String selfMuted

Media is self muted.

MODERATOR_MUTED String moderatorMuted

Media is muted by moderator.

BOTH_MUTED String 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
AVAILABLE String available

Media is active.

NA String na

No media stream exists.

<static, readonly> MediaType :String

Determines media type

Type:
  • String
Properties:
Name Type Default Description
AUDIO String audio

This is audio media type.

VIDEO String video

This is video media type.

<static, readonly> MeetingEncryptionStatus :String

Determines status of meeting's encryption

Type:
  • String
Properties:
Name Type Default Description
YES String yes

Meeting is encrypted.

NO String no

Meeting is not encrypted.

PARTIAL String partial

Meeting is partially encrypted.

<static, readonly> ModeratorAdmissionActions :String

Contains possible participant connection statuses.

Type:
  • String
Properties:
Name Type Default Description
ADMIT String admit

Admit pending participant.

REJECT String reject

Reject pending participant.

<static, readonly> ParticipantAuthorizationStatus :String

Determines participant status

Type:
  • String
Properties:
Name Type Default Description
ACTIVE String active

Participant has active status.

AUTHORIZING String authorizing

Participant has authorizing status .

<static, readonly> ParticipantConnectionStatus :String

Contains possible participant connection statuses.

Type:
  • String
Properties:
Name Type Default Description
CONNECTION_STATUS_UNKNOWN String CONNECTION_STATUS_UNKNOWN

Connection status is unknown.

CONNECTION_STATUS_CONNECTING String CONNECTION_STATUS_CONNECTING

Participant is connecting.

CONNECTION_STATUS_CONNECTED String CONNECTION_STATUS_CONNECTED

Participant has connected.

CONNECTION_STATUS_DISCONNECTING String CONNECTION_STATUS_DISCONNECTING

Participant is disconnecting.

CONNECTION_STATUS_DISCONNECTED String CONNECTION_STATUS_DISCONNECTED

Participant has disconnected.

<static, readonly> ParticipantDisconnectionReason :String

Contains possible participant disconnection reasons.

Type:
  • String
Properties:
Name Type Default Description
DISCONNECT_REASON_UNKNOWN String DISCONNECT_REASON_UNKNOWN

Reason of disconnection is unknown.

DISCONNECT_REASON_DEPARTED String DISCONNECT_REASON_DEPARTED

Reason: departed.

DISCONNECT_REASON_DISCONNECTED_BY_MODERATOR String 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_MEDIA String MEDIA_STATUS_NO_MEDIA

No media.

MEDIA_STATUS_INACTIVE String MEDIA_STATUS_INACTIVE

Media is inactive.

MEDIA_STATUS_RECEIVE_ONLY String MEDIA_STATUS_RECEIVE_ONLY

Media can be only received.

MEDIA_STATUS_SEND_ONLY String MEDIA_STATUS_SEND_ONLY

Media can be only sent.

MEDIA_STATUS_SEND_RECEIVE String 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
MODERATOR String moderator

This participant is a moderator.

PARTICIPANT String participant

This participant is a ordinary participant.

GUEST String guest

This participant is a guest.

OPERATOR String operator

This participant is an operator.

RESTRICTED_PARTICIPANT String 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
ON String on

Recording is on.

OFF String off

Recording is off.

PAUSE String pause

Recording is paused.

<static, readonly> VideoLayout :String

Determines media type

Type:
  • String
Properties:
Name Type Default Description
LAYOUT_AUTOMATIC String 1

Automatic.

LAYOUT_SINGLE_SCREEN String 10

Single full-screen video.

LAYOUT_DOUBLE_SCREEN_HORIZONTAL String 21

Two smaller landscape videos tiled next to one another.

LAYOUT_DOUBLE_SCREEN_VERTICAL String 22

Two smaller landscape videos tiled above one another.

LAYOUT_DOUBLE_SCREEN_4_TO_1 String 27

Two videos next to each other, large one to the left, smaller one to the right.

LAYOUT_1_HOST_1_PIP String 28

Two videos, one full screen, the other a small video inlayed in the lower center of the screen.

LAYOUT_PYRAMID_3 String 32

Three landscape videos, one above center, two tiled horizontally underneath.

LAYOUT_LANDSCAPE_PLUS_2_ASYM String 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_PIP String 34

Three videos, one full screen, two inlayed in the lower center of the screen.

LAYOUT_3x1 String 35

Three videos, all set horizontally in the center of the screen.

LAYOUT_2x2 String 40

Four landscape videos of equal size, two in the top row, two beneath, full square.

LAYOUT_4_PYRAMID String 41

Four videos in two rows, one large video on top, three smaller ones underneath.

LAYOUT_3_PLUS_1 String 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_PIP String 43

Four videos, one full screen, three inlayed in the lower center of the screen.

LAYOUT_5_PYRAMID String 51

Five videos in two rows, one large video on top, four smaller ones underneath.

LAYOUT_1_HOST_4_PIP String 52

Five videos, one full screen, four inlayed in the lower center of the screen.

LAYOUT_5_PLUS_1 String 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_3x2 String 61

Six landscape videos of equal size arranged in two rows.

LAYOUT_6_PLUS_1_1 String 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_NEW String 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_4x2 String 82

Eight videos of equal size arranged in two rows of four.

LAYOUT_3x3 String 90

Nine videos of equal size arranged in three rows, three per row.

LAYOUT_9_PYRAMID String 91

Nine videos, one larger on top and eight smaller ones beneath arranged in two rows of four.

LAYOUT_8_PLUS_2_1_2 String 101

Ten videos where the top two quadrants contain two larger videos, while the lower two quadrants have four videos in each.

LAYOUT_4x3 String 120

12 videos of equal size arranged in three rows, four per row.

LAYOUT_12_PLUS_1_1 String 131

13 videos where the top left quadrant has a large video, the remaining three quadrants have four videos each.

LAYOUT_12_PLUS_1_5 String 135

13 videos, one large video in the center surrounded by twelve smaller equally sized videos around the edge of the screen.

LAYOUT_4x4 String 160

16 videos of the same size, arranged in four rows of four.

LAYOUT_20_PLUS_1 String 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_LEFT String 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_27 String 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
name AvayaClientServices.Services.Conference.ConferenceError
message string
©2016 Avaya Inc. All Rights Reserved.