@microsoft/teams-js 2.0.0-beta.6-dev.6 → 2.0.0-beta.6-dev.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/MicrosoftTeams.d.ts +92 -230
- package/dist/MicrosoftTeams.js +458 -319
- package/dist/MicrosoftTeams.js.map +1 -1
- package/dist/MicrosoftTeams.min.js +1 -1
- package/dist/MicrosoftTeams.min.js.map +1 -1
- package/package.json +1 -1
package/dist/MicrosoftTeams.d.ts
CHANGED
@@ -3448,7 +3448,8 @@ export namespace menus {
|
|
3448
3448
|
}
|
3449
3449
|
|
3450
3450
|
/**
|
3451
|
-
* @
|
3451
|
+
* @deprecated
|
3452
|
+
* As of 2.0.0-beta.6, use media only for backwards compatibility of existing code.
|
3452
3453
|
*/
|
3453
3454
|
export namespace media {
|
3454
3455
|
/**
|
@@ -3486,29 +3487,19 @@ export namespace media {
|
|
3486
3487
|
name?: string;
|
3487
3488
|
}
|
3488
3489
|
/**
|
3489
|
-
* Launch camera, capture image or choose image from gallery and return the images as a File[] object
|
3490
|
-
*
|
3491
|
-
* @remarks
|
3492
|
-
* Note: Currently we support getting one File through this API, i.e. the file arrays size will be one.
|
3493
|
-
* Note: For desktop, this API is not supported. Promise will be rejected with ErrorCode.NotSupported.
|
3494
|
-
*
|
3495
|
-
* @returns A promise resolved with a collection of @see File objects or rejected with an @see SdkError
|
3496
|
-
*/
|
3497
|
-
export function captureImage(): Promise<File[]>;
|
3498
|
-
/**
|
3499
|
-
* Launch camera, capture image or choose image from gallery and return the images as a File[] object
|
3500
|
-
*
|
3501
|
-
* @param callback - Callback to invoke when the image is captured.
|
3502
|
-
*
|
3503
3490
|
* @deprecated
|
3504
|
-
* As of 2.0.0-beta.
|
3491
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
3492
|
+
*
|
3493
|
+
* Launch camera, capture image or choose image from gallery and return the images as a File[] object to the callback.
|
3505
3494
|
*
|
3495
|
+
* @params callback - Callback will be called with an @see SdkError if there are any.
|
3496
|
+
* If error is null or undefined, the callback will be called with a collection of @see File objects
|
3506
3497
|
* @remarks
|
3507
3498
|
* Note: Currently we support getting one File through this API, i.e. the file arrays size will be one.
|
3508
3499
|
* Note: For desktop, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
|
3509
3500
|
*
|
3510
3501
|
*/
|
3511
|
-
export function captureImage(callback: (error
|
3502
|
+
export function captureImage(callback: (error: SdkError, files: File[]) => void): void;
|
3512
3503
|
/**
|
3513
3504
|
* Media object returned by the select Media API
|
3514
3505
|
*/
|
@@ -3521,17 +3512,8 @@ export namespace media {
|
|
3521
3512
|
preview: string;
|
3522
3513
|
/**
|
3523
3514
|
* Gets the media in chunks irrespective of size, these chunks are assembled and sent back to the webapp as file/blob
|
3524
|
-
*
|
3525
|
-
*
|
3526
|
-
*/
|
3527
|
-
getMedia(): Promise<Blob>;
|
3528
|
-
/**
|
3529
|
-
* Gets the media in chunks irrespective of size, these chunks are assembled and sent back to the webapp as file/blob
|
3530
|
-
*
|
3531
|
-
* @deprecated
|
3532
|
-
* As of 2.0.0-beta.1, please use {@link media.Media.getMedia media.Media.getMedia(): Promise\<Blob\>} instead.
|
3533
|
-
*
|
3534
|
-
* @param callback - returns blob of media
|
3515
|
+
* @param callback - callback is called with the @see SdkError if there is an error
|
3516
|
+
* If error is null or undefined, the callback will be called with @see Blob.
|
3535
3517
|
*/
|
3536
3518
|
getMedia(callback: (error: SdkError, blob: Blob) => void): void;
|
3537
3519
|
}
|
@@ -3664,7 +3646,7 @@ export namespace media {
|
|
3664
3646
|
*/
|
3665
3647
|
abstract class MediaController<T> {
|
3666
3648
|
protected controllerCallback: T;
|
3667
|
-
constructor(controllerCallback
|
3649
|
+
constructor(controllerCallback?: T);
|
3668
3650
|
protected abstract getMediaType(): MediaType;
|
3669
3651
|
/**
|
3670
3652
|
* @hidden
|
@@ -3679,20 +3661,6 @@ export namespace media {
|
|
3679
3661
|
* @hidden
|
3680
3662
|
* Hide from docs
|
3681
3663
|
* --------
|
3682
|
-
*
|
3683
|
-
* Function to notify the host client to programatically control the experience
|
3684
|
-
* @param mediaEvent indicates what the event that needs to be signaled to the host client
|
3685
|
-
* @returns A promise resolved promise
|
3686
|
-
*/
|
3687
|
-
protected notifyEventToHost(mediaEvent: MediaControllerEvent): Promise<void>;
|
3688
|
-
/**
|
3689
|
-
* @hidden
|
3690
|
-
* Hide from docs
|
3691
|
-
* --------
|
3692
|
-
*
|
3693
|
-
* @deprecated
|
3694
|
-
* As of 2.0.0-beta.3, please use {@link media.MediaController.notifyEventToHost media.MediaController.notifyEventToHost(mediaEvent: MediaControllerEvent): Promise\<void\>} instead.
|
3695
|
-
*
|
3696
3664
|
* Function to notify the host client to programatically control the experience
|
3697
3665
|
* @param mediaEvent indicates what the event that needs to be signaled to the host client
|
3698
3666
|
* Optional; @param callback is used to send app if host client has successfully handled the notification event or not
|
@@ -3700,17 +3668,6 @@ export namespace media {
|
|
3700
3668
|
protected notifyEventToHost(mediaEvent: MediaControllerEvent, callback?: (err?: SdkError) => void): void;
|
3701
3669
|
/**
|
3702
3670
|
* Function to programatically stop the ongoing media event
|
3703
|
-
*
|
3704
|
-
* @returns A resolved promise
|
3705
|
-
* */
|
3706
|
-
stop(): Promise<void>;
|
3707
|
-
/**
|
3708
|
-
*
|
3709
|
-
* Function to programatically stop the ongoing media event
|
3710
|
-
*
|
3711
|
-
* @deprecated
|
3712
|
-
* As of 2.0.0-beta.3, please use {@link media.MediaController.stop media.MediaController.stop(): Promise\<void\>} instead.
|
3713
|
-
*
|
3714
3671
|
* Optional; @param callback is used to send app if host client has successfully stopped the event or not
|
3715
3672
|
*/
|
3716
3673
|
stop(callback?: (err?: SdkError) => void): void;
|
@@ -3719,8 +3676,7 @@ export namespace media {
|
|
3719
3676
|
* Callback which will register your app to listen to lifecycle events during the video capture flow
|
3720
3677
|
*/
|
3721
3678
|
export interface VideoControllerCallback {
|
3722
|
-
onRecordingStarted(): void;
|
3723
|
-
onRecordingStopped?(): void;
|
3679
|
+
onRecordingStarted?(): void;
|
3724
3680
|
}
|
3725
3681
|
/**
|
3726
3682
|
* VideoController class is used to communicate between the app and the host client during the video capture flow
|
@@ -3819,39 +3775,24 @@ export namespace media {
|
|
3819
3775
|
file: Blob;
|
3820
3776
|
}
|
3821
3777
|
/**
|
3822
|
-
*
|
3778
|
+
* @deprecated
|
3779
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
3823
3780
|
*
|
3824
|
-
* @param mediaInputs - The input params to customize the media to be selected
|
3825
|
-
* @returns A promise resolved with an array of media data or rejected with an @see SdkError
|
3826
|
-
*/
|
3827
|
-
export function selectMedia(mediaInputs: MediaInputs): Promise<Media[]>;
|
3828
|
-
/**
|
3829
3781
|
* Select an attachment using camera/gallery
|
3830
3782
|
*
|
3831
|
-
* @deprecated
|
3832
|
-
* As of 2.0.0-beta.1, please use {@link media.selectMedia media.selectMedia(mediaInputs: MediaInputs): Promise\<Media[]\>} instead.
|
3833
|
-
*
|
3834
3783
|
* @param mediaInputs - The input params to customize the media to be selected
|
3835
3784
|
* @param callback - The callback to invoke after fetching the media
|
3836
3785
|
*/
|
3837
|
-
export function selectMedia(mediaInputs: MediaInputs, callback: (error: SdkError, attachments: Media[]) => void):
|
3838
|
-
/**
|
3839
|
-
* View images using native image viewer
|
3840
|
-
*
|
3841
|
-
* @param uriList - list of URIs for images to be viewed - can be content URI or server URL. Supports up to 10 Images in a single call
|
3842
|
-
* @returns A promise resolved when the viewing action is completed or rejected with an @see SdkError
|
3843
|
-
*/
|
3844
|
-
export function viewImages(uriList: ImageUri[]): Promise<void>;
|
3786
|
+
export function selectMedia(mediaInputs: MediaInputs, callback: (error: SdkError, attachments: Media[]) => void): void;
|
3845
3787
|
/**
|
3846
|
-
* View images using native image viewer
|
3847
|
-
*
|
3848
3788
|
* @deprecated
|
3849
|
-
* As of 2.0.0-beta.
|
3789
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
3850
3790
|
*
|
3791
|
+
* View images using native image viewer
|
3851
3792
|
* @param uriList - list of URIs for images to be viewed - can be content URI or server URL. Supports up to 10 Images in a single call
|
3852
3793
|
* @param callback - returns back error if encountered, returns null in case of success
|
3853
3794
|
*/
|
3854
|
-
export function viewImages(uriList: ImageUri[], callback: (error?: SdkError) => void):
|
3795
|
+
export function viewImages(uriList: ImageUri[], callback: (error?: SdkError) => void): void;
|
3855
3796
|
/**
|
3856
3797
|
* Barcode configuration supplied to scanBarCode API to customize barcode scanning experience in mobile
|
3857
3798
|
* All properties in BarCodeConfig are optional and have default values in the platform
|
@@ -3864,29 +3805,17 @@ export namespace media {
|
|
3864
3805
|
timeOutIntervalInSec?: number;
|
3865
3806
|
}
|
3866
3807
|
/**
|
3867
|
-
*
|
3868
|
-
*
|
3869
|
-
* @remarks
|
3870
|
-
* Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
|
3808
|
+
* @deprecated
|
3809
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
3871
3810
|
*
|
3872
|
-
* @param config - optional input configuration to customize the barcode scanning experience
|
3873
|
-
* @returns A promise resolved with the barcode data or rejected with an @see SdkError
|
3874
|
-
*/
|
3875
|
-
export function scanBarCode(config?: BarCodeConfig): Promise<string>;
|
3876
|
-
/**
|
3877
3811
|
* Scan Barcode/QRcode using camera
|
3878
|
-
*
|
3879
3812
|
* @remarks
|
3880
3813
|
* Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
|
3881
3814
|
*
|
3882
|
-
* @deprecated
|
3883
|
-
* As of 2.0.0-beta.1, please use {@link media.scanBarCode media.scanBarCode(config?: BarCodeConfig): Promise\<string\>} instead.
|
3884
|
-
*
|
3885
3815
|
* @param callback - callback to invoke after scanning the barcode
|
3886
3816
|
* @param config - optional input configuration to customize the barcode scanning experience
|
3887
3817
|
*/
|
3888
|
-
export function scanBarCode(callback: (error: SdkError, decodedText: string) => void, config?: BarCodeConfig):
|
3889
|
-
export function isSupported(): boolean;
|
3818
|
+
export function scanBarCode(callback: (error: SdkError, decodedText: string) => void, config?: BarCodeConfig): void;
|
3890
3819
|
export {};
|
3891
3820
|
}
|
3892
3821
|
|
@@ -3961,7 +3890,8 @@ export namespace location {
|
|
3961
3890
|
}
|
3962
3891
|
|
3963
3892
|
/**
|
3964
|
-
* @
|
3893
|
+
* @deprecated
|
3894
|
+
* As of 2.0.0-beta.6, use meeting only for backwards compatibility of existing code.
|
3965
3895
|
*/
|
3966
3896
|
export namespace meeting {
|
3967
3897
|
/**
|
@@ -3971,12 +3901,12 @@ export namespace meeting {
|
|
3971
3901
|
*
|
3972
3902
|
* @internal
|
3973
3903
|
*/
|
3974
|
-
interface
|
3904
|
+
interface IMeetingDetailsResponse {
|
3975
3905
|
/**
|
3976
3906
|
* @hidden
|
3977
3907
|
* details object
|
3978
3908
|
*/
|
3979
|
-
details:
|
3909
|
+
details: IMeetingDetails | ICallDetails;
|
3980
3910
|
/**
|
3981
3911
|
* @hidden
|
3982
3912
|
* conversation object
|
@@ -3991,36 +3921,47 @@ export namespace meeting {
|
|
3991
3921
|
/**
|
3992
3922
|
* @hidden
|
3993
3923
|
* Hide from docs
|
3994
|
-
*
|
3995
|
-
*
|
3996
|
-
* @internal
|
3924
|
+
* Base data structure to represent a meeting or call detail
|
3997
3925
|
*/
|
3998
|
-
interface
|
3926
|
+
interface IMeetingOrCallDetailsBase<T> {
|
3999
3927
|
/**
|
4000
3928
|
* @hidden
|
4001
|
-
* Scheduled start time of the meeting
|
3929
|
+
* Scheduled start time of the meeting or start time of the call
|
4002
3930
|
*/
|
4003
3931
|
scheduledStartTime: string;
|
4004
3932
|
/**
|
4005
3933
|
* @hidden
|
4006
|
-
*
|
3934
|
+
* url to join the current meeting or call
|
4007
3935
|
*/
|
4008
|
-
|
3936
|
+
joinUrl?: string;
|
4009
3937
|
/**
|
4010
3938
|
* @hidden
|
4011
|
-
*
|
3939
|
+
* type of the meeting or call
|
4012
3940
|
*/
|
4013
|
-
|
3941
|
+
type?: T;
|
3942
|
+
}
|
3943
|
+
/**
|
3944
|
+
* @hidden
|
3945
|
+
* Hide from docs
|
3946
|
+
* Data structure to represent call details
|
3947
|
+
*/
|
3948
|
+
type ICallDetails = IMeetingOrCallDetailsBase<CallType>;
|
3949
|
+
/**
|
3950
|
+
* @hidden
|
3951
|
+
* Hide from docs
|
3952
|
+
* Data structure to represent meeting details.
|
3953
|
+
*/
|
3954
|
+
interface IMeetingDetails extends IMeetingOrCallDetailsBase<MeetingType> {
|
4014
3955
|
/**
|
4015
3956
|
* @hidden
|
4016
|
-
*
|
3957
|
+
* Scheduled end time of the meeting
|
4017
3958
|
*/
|
4018
|
-
|
3959
|
+
scheduledEndTime: string;
|
4019
3960
|
/**
|
4020
3961
|
* @hidden
|
4021
|
-
*
|
3962
|
+
* meeting title name of the meeting
|
4022
3963
|
*/
|
4023
|
-
|
3964
|
+
title?: string;
|
4024
3965
|
}
|
4025
3966
|
/**
|
4026
3967
|
* @hidden
|
@@ -4070,6 +4011,12 @@ export namespace meeting {
|
|
4070
4011
|
message?: string;
|
4071
4012
|
};
|
4072
4013
|
}
|
4014
|
+
interface IAppContentStageSharingCapabilities {
|
4015
|
+
/**
|
4016
|
+
* indicates whether app has permission to share contents to meeting stage
|
4017
|
+
*/
|
4018
|
+
doesAppHaveSharePermission: boolean;
|
4019
|
+
}
|
4073
4020
|
interface IAppContentStageSharingState {
|
4074
4021
|
/**
|
4075
4022
|
* indicates whether app is currently being shared to stage
|
@@ -4083,12 +4030,6 @@ export namespace meeting {
|
|
4083
4030
|
*/
|
4084
4031
|
isSpeakingDetected: boolean;
|
4085
4032
|
}
|
4086
|
-
interface IAppContentStageSharingCapabilities {
|
4087
|
-
/**
|
4088
|
-
* indicates whether app has permission to share contents to meeting stage
|
4089
|
-
*/
|
4090
|
-
doesAppHaveSharePermission: boolean;
|
4091
|
-
}
|
4092
4033
|
enum MeetingType {
|
4093
4034
|
Unknown = "Unknown",
|
4094
4035
|
Adhoc = "Adhoc",
|
@@ -4097,41 +4038,28 @@ export namespace meeting {
|
|
4097
4038
|
Broadcast = "Broadcast",
|
4098
4039
|
MeetNow = "MeetNow"
|
4099
4040
|
}
|
4100
|
-
|
4101
|
-
|
4102
|
-
|
4103
|
-
|
4104
|
-
* error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
|
4105
|
-
* result can either contain the true/false value, incase of a successful fetch or null when the fetching fails
|
4106
|
-
*
|
4107
|
-
* @returns Promise result where true means incoming audio is muted and false means incoming audio is unmuted
|
4108
|
-
*/
|
4109
|
-
function getIncomingClientAudioState(): Promise<boolean>;
|
4041
|
+
enum CallType {
|
4042
|
+
OneOnOneCall = "oneOnOneCall",
|
4043
|
+
GroupCall = "groupCall"
|
4044
|
+
}
|
4110
4045
|
/**
|
4111
4046
|
* @deprecated
|
4112
|
-
* As of 2.0.0-beta.
|
4047
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4113
4048
|
*
|
4114
4049
|
* Allows an app to get the incoming audio speaker setting for the meeting user
|
4115
4050
|
*
|
4116
4051
|
* @param callback - Callback contains 2 parameters, error and result.
|
4052
|
+
*
|
4117
4053
|
* error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
|
4118
4054
|
* result can either contain the true/false value, incase of a successful fetch or null when the fetching fails
|
4119
4055
|
* result: True means incoming audio is muted and false means incoming audio is unmuted
|
4120
4056
|
*/
|
4121
4057
|
function getIncomingClientAudioState(callback: (error: SdkError | null, result: boolean | null) => void): void;
|
4122
|
-
/**
|
4123
|
-
* Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa
|
4124
|
-
*
|
4125
|
-
* @remarks
|
4126
|
-
* error can either contain an error of type SdkError, incase of an error, or null when toggle is successful
|
4127
|
-
* result can either contain the true/false value, incase of a successful toggle or null when the toggling fails
|
4128
|
-
*
|
4129
|
-
* @returns Promise result where true means incoming audio is muted and false means incoming audio is unmuted or rejected promise containing SdkError details
|
4130
|
-
*/
|
4131
|
-
function toggleIncomingClientAudio(): Promise<boolean>;
|
4132
4058
|
/**
|
4133
4059
|
* @deprecated
|
4134
|
-
* As of 2.0.0-beta.
|
4060
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4061
|
+
*
|
4062
|
+
* Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa
|
4135
4063
|
*
|
4136
4064
|
* @param callback - Callback contains 2 parameters, error and result.
|
4137
4065
|
* error can either contain an error of type SdkError, incase of an error, or null when toggle is successful
|
@@ -4139,50 +4067,29 @@ export namespace meeting {
|
|
4139
4067
|
* result: True means incoming audio is muted and false means incoming audio is unmuted
|
4140
4068
|
*/
|
4141
4069
|
function toggleIncomingClientAudio(callback: (error: SdkError | null, result: boolean | null) => void): void;
|
4142
|
-
/**
|
4143
|
-
* @hidden
|
4144
|
-
* Hide from docs
|
4145
|
-
*
|
4146
|
-
* Allows an app to get the meeting details for the meeting
|
4147
|
-
*
|
4148
|
-
* @returns Promise containing the meeting details in IMeetingDetails form or rejected promise containing SdkError details
|
4149
|
-
*
|
4150
|
-
* @internal
|
4151
|
-
*/
|
4152
|
-
function getMeetingDetails(): Promise<IMeetingDetails>;
|
4153
4070
|
/**
|
4154
4071
|
* @deprecated
|
4155
|
-
* As of 2.0.0-beta.
|
4072
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4156
4073
|
*
|
4157
4074
|
* @hidden
|
4158
4075
|
* Hide from docs
|
4159
4076
|
*
|
4160
4077
|
* Allows an app to get the meeting details for the meeting
|
4161
4078
|
*
|
4162
|
-
* @param callback - Callback contains 2 parameters, error and
|
4079
|
+
* @param callback - Callback contains 2 parameters, error and meetingDetailsResponse.
|
4163
4080
|
* error can either contain an error of type SdkError, incase of an error, or null when get is successful
|
4164
|
-
* result can either contain a
|
4081
|
+
* result can either contain a IMeetingDetailsResponse value, incase of a successful get or null when the get fails
|
4165
4082
|
*
|
4166
4083
|
* @internal
|
4167
4084
|
*/
|
4168
|
-
function getMeetingDetails(callback: (error: SdkError | null, meetingDetails:
|
4169
|
-
/**
|
4170
|
-
* @hidden
|
4171
|
-
* Allows an app to get the authentication token for the anonymous or guest user in the meeting
|
4172
|
-
*
|
4173
|
-
* @returns Promise containing the token or rejected promise containing SdkError details
|
4174
|
-
*
|
4175
|
-
* @internal
|
4176
|
-
*/
|
4177
|
-
function getAuthenticationTokenForAnonymousUser(): Promise<string>;
|
4085
|
+
function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
|
4178
4086
|
/**
|
4179
4087
|
* @deprecated
|
4180
|
-
* As of 2.0.0-beta.
|
4088
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4181
4089
|
*
|
4182
4090
|
* @hidden
|
4183
|
-
* Hide from docs
|
4184
|
-
*
|
4185
4091
|
* Allows an app to get the authentication token for the anonymous or guest user in the meeting
|
4092
|
+
*
|
4186
4093
|
* @param callback - Callback contains 2 parameters, error and authenticationTokenOfAnonymousUser.
|
4187
4094
|
* error can either contain an error of type SdkError, incase of an error, or null when get is successful
|
4188
4095
|
* authenticationTokenOfAnonymousUser can either contain a string value, incase of a successful get or null when the get fails
|
@@ -4190,16 +4097,9 @@ export namespace meeting {
|
|
4190
4097
|
* @internal
|
4191
4098
|
*/
|
4192
4099
|
function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
|
4193
|
-
function isSupported(): boolean;
|
4194
|
-
/**
|
4195
|
-
* Allows an app to get the state of the live stream in the current meeting
|
4196
|
-
*
|
4197
|
-
* @returns Promise containing the LiveStreamState value or rejected promise containing SdkError details
|
4198
|
-
*/
|
4199
|
-
function getLiveStreamState(): Promise<LiveStreamState>;
|
4200
4100
|
/**
|
4201
4101
|
* @deprecated
|
4202
|
-
* As of 2.0.0-beta.
|
4102
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4203
4103
|
*
|
4204
4104
|
* Allows an app to get the state of the live stream in the current meeting
|
4205
4105
|
*
|
@@ -4209,6 +4109,9 @@ export namespace meeting {
|
|
4209
4109
|
*/
|
4210
4110
|
function getLiveStreamState(callback: (error: SdkError | null, liveStreamState: LiveStreamState | null) => void): void;
|
4211
4111
|
/**
|
4112
|
+
* @deprecated
|
4113
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4114
|
+
*
|
4212
4115
|
* Allows an app to request the live streaming be started at the given streaming url
|
4213
4116
|
*
|
4214
4117
|
* @remarks
|
@@ -4216,42 +4119,25 @@ export namespace meeting {
|
|
4216
4119
|
*
|
4217
4120
|
* @param streamUrl - the url to the stream resource
|
4218
4121
|
* @param streamKey - the key to the stream resource
|
4219
|
-
* @
|
4122
|
+
* @param callback - Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
|
4220
4123
|
*/
|
4221
|
-
function requestStartLiveStreaming(streamUrl: string, streamKey?: string):
|
4124
|
+
function requestStartLiveStreaming(callback: (error: SdkError | null) => void, streamUrl: string, streamKey?: string): void;
|
4222
4125
|
/**
|
4223
4126
|
* @deprecated
|
4224
|
-
* As of 2.0.0-beta.
|
4225
|
-
*
|
4226
|
-
* Allows an app to request the live streaming be started at the given streaming url
|
4227
|
-
*
|
4228
|
-
* @param streamUrl - The url to the stream resource
|
4229
|
-
* @param streamKey - The key to the stream resource
|
4230
|
-
* @param callback - Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
|
4127
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4231
4128
|
*
|
4232
|
-
* Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
|
4233
|
-
*/
|
4234
|
-
function requestStartLiveStreaming(callback: (error: SdkError | null) => void, streamUrl: string, streamKey?: string): Promise<void>;
|
4235
|
-
/**
|
4236
4129
|
* Allows an app to request the live streaming be stopped at the given streaming url
|
4237
4130
|
*
|
4238
4131
|
* @remarks
|
4239
4132
|
* Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
|
4240
4133
|
*
|
4241
|
-
* @returns Promise that will be resolved when the operation has completed or rejected with SdkError value
|
4242
|
-
*/
|
4243
|
-
function requestStopLiveStreaming(): Promise<void>;
|
4244
|
-
/**
|
4245
|
-
* @deprecated
|
4246
|
-
* As of 2.0.0-beta.1, please use {@link meeting.requestStopLiveStreaming meeting.requestStopLiveStreaming(): Promise\<void\>} instead.
|
4247
|
-
*
|
4248
|
-
* Allows an app to request the live streaming be stopped at the given streaming url
|
4249
4134
|
* @param callback - Callback contains error parameter which can be of type SdkError in case of an error, or null when operation is successful
|
4250
|
-
*
|
4251
|
-
* Use getLiveStreamState or registerLiveStreamChangedHandler to get updates on the live stream state
|
4252
4135
|
*/
|
4253
4136
|
function requestStopLiveStreaming(callback: (error: SdkError | null) => void): void;
|
4254
4137
|
/**
|
4138
|
+
* @deprecated
|
4139
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4140
|
+
*
|
4255
4141
|
* Registers a handler for changes to the live stream.
|
4256
4142
|
*
|
4257
4143
|
* @remarks
|
@@ -4260,16 +4146,9 @@ export namespace meeting {
|
|
4260
4146
|
* @param handler - The handler to invoke when the live stream state changes
|
4261
4147
|
*/
|
4262
4148
|
function registerLiveStreamChangedHandler(handler: (liveStreamState: LiveStreamState) => void): void;
|
4263
|
-
/**
|
4264
|
-
* Allows an app to share contents in the meeting
|
4265
|
-
*
|
4266
|
-
* @param appContentUrl - appContentUrl is the input URL which needs to be shared on to the stage
|
4267
|
-
* @returns Promise resolved indicating whether or not the share was successful or rejected with SdkError value
|
4268
|
-
*/
|
4269
|
-
function shareAppContentToStage(appContentUrl: string): Promise<boolean>;
|
4270
4149
|
/**
|
4271
4150
|
* @deprecated
|
4272
|
-
* As of 2.0.0-beta.
|
4151
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4273
4152
|
*
|
4274
4153
|
* Allows an app to share contents in the meeting
|
4275
4154
|
*
|
@@ -4279,17 +4158,11 @@ export namespace meeting {
|
|
4279
4158
|
* @param appContentUrl - is the input URL which needs to be shared on to the stage
|
4280
4159
|
*/
|
4281
4160
|
function shareAppContentToStage(callback: (error: SdkError | null, result: boolean | null) => void, appContentUrl: string): void;
|
4282
|
-
/**
|
4283
|
-
* Provides information related to app's in-meeting sharing capabilities
|
4284
|
-
*
|
4285
|
-
* @returns Promise resolved with sharing capability details or rejected with SdkError value
|
4286
|
-
*/
|
4287
|
-
function getAppContentStageSharingCapabilities(): Promise<IAppContentStageSharingCapabilities>;
|
4288
4161
|
/**
|
4289
4162
|
* @deprecated
|
4290
|
-
* As of 2.0.0-beta.
|
4163
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4291
4164
|
*
|
4292
|
-
* Provides information related
|
4165
|
+
* Provides information related app's in-meeting sharing capabilities
|
4293
4166
|
*
|
4294
4167
|
* @param callback - Callback contains 2 parameters, error and result.
|
4295
4168
|
* error can either contain an error of type SdkError (error indication), or null (non-error indication)
|
@@ -4297,40 +4170,25 @@ export namespace meeting {
|
|
4297
4170
|
* (indication of successful retrieval), or null (indication of failed retrieval)
|
4298
4171
|
*/
|
4299
4172
|
function getAppContentStageSharingCapabilities(callback: (error: SdkError | null, appContentStageSharingCapabilities: IAppContentStageSharingCapabilities | null) => void): void;
|
4300
|
-
/**
|
4301
|
-
* @hidden
|
4302
|
-
* Hide from docs.
|
4303
|
-
* ------------------------------------------
|
4304
|
-
* Terminates current stage sharing session in meeting
|
4305
|
-
*
|
4306
|
-
* @returns Promise resolved indicating whether or not sharing successfully stopped or rejected with SdkError value
|
4307
|
-
*/
|
4308
|
-
function stopSharingAppContentToStage(): Promise<boolean>;
|
4309
4173
|
/**
|
4310
4174
|
* @deprecated
|
4311
|
-
* As of 2.0.0-beta.
|
4175
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4312
4176
|
*
|
4313
4177
|
* @hidden
|
4314
4178
|
* Hide from docs.
|
4315
|
-
* ------------------------------------------
|
4316
4179
|
* Terminates current stage sharing session in meeting
|
4317
|
-
*
|
4180
|
+
*
|
4181
|
+
* @param callback - Callback contains 2 parameters, error and result.
|
4318
4182
|
* error can either contain an error of type SdkError (error indication), or null (non-error indication)
|
4319
4183
|
* result can either contain a true boolean value (successful termination), or null (unsuccessful fetch)
|
4320
|
-
* @internal
|
4321
4184
|
*/
|
4322
4185
|
function stopSharingAppContentToStage(callback: (error: SdkError | null, result: boolean | null) => void): void;
|
4323
|
-
/**
|
4324
|
-
* Provides information related to current stage sharing state for app
|
4325
|
-
*
|
4326
|
-
* @returns Promise resolved to the App Content Stage Sharing State, or rejected with SdkError value
|
4327
|
-
*/
|
4328
|
-
function getAppContentStageSharingState(): Promise<IAppContentStageSharingState>;
|
4329
4186
|
/**
|
4330
4187
|
* @deprecated
|
4331
|
-
* As of 2.0.0-beta.
|
4188
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4332
4189
|
*
|
4333
4190
|
* Provides information related to current stage sharing state for app
|
4191
|
+
*
|
4334
4192
|
* @param callback - Callback contains 2 parameters, error and result.
|
4335
4193
|
* error can either contain an error of type SdkError (error indication), or null (non-error indication)
|
4336
4194
|
* appContentStageSharingState can either contain an IAppContentStageSharingState object
|
@@ -4338,9 +4196,13 @@ export namespace meeting {
|
|
4338
4196
|
*/
|
4339
4197
|
function getAppContentStageSharingState(callback: (error: SdkError | null, appContentStageSharingState: IAppContentStageSharingState | null) => void): void;
|
4340
4198
|
/**
|
4199
|
+
* @deprecated
|
4200
|
+
* As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
|
4201
|
+
*
|
4341
4202
|
* Registers a handler for changes to paticipant speaking states. If any participant is speaking, isSpeakingDetected
|
4342
4203
|
* will be true. If no participants are speaking, isSpeakingDetected will be false. Only one handler can be registered
|
4343
4204
|
* at a time. A subsequent registration replaces an existing registration.
|
4205
|
+
*
|
4344
4206
|
* @param handler The handler to invoke when the speaking state of any participant changes (start/stop speaking).
|
4345
4207
|
*/
|
4346
4208
|
function registerSpeakingStateChangeHandler(handler: (speakingState: ISpeakingState) => void): void;
|