1616import com .azure .core .util .logging .ClientLogger ;
1717
1818/**
19- * Sync Client that supports call connection operations.
19+ * Synchronous Client that supports call connection operations.
2020 */
2121public final class CallConnection {
2222 private final CallConnectionAsync callConnectionAsync ;
@@ -27,16 +27,16 @@ public final class CallConnection {
2727 }
2828
2929 /**
30- * Get the call connection id property
30+ * Get the call connection id property.
3131 *
32- * @return the id value.
32+ * @return Call connection id value.
3333 */
3434 public String getCallConnectionId () {
3535 return callConnectionAsync .getCallConnectionId ();
3636 }
3737
3838 /**
39- * Play audio in a call.
39+ * Play audio in the call.
4040 *
4141 * @param audioFileUri The media resource uri of the play audio request. Currently only Wave file (.wav) format
4242 * audio prompts are supported. More specifically, the audio content in the wave file must
@@ -48,7 +48,7 @@ public String getCallConnectionId() {
4848 * communications related to this operation
4949 * @throws CallingServerErrorException thrown if the request is rejected by server.
5050 * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
51- * @return the response payload for play audio operation.
51+ * @return Response payload for play audio operation.
5252 */
5353 @ ServiceMethod (returns = ReturnType .SINGLE )
5454 public PlayAudioResult playAudio (
@@ -62,23 +62,23 @@ public PlayAudioResult playAudio(
6262 }
6363
6464 /**
65- * Play audio in a call.
65+ * Play audio in the call.
6666 *
6767 * @param audioFileUri The media resource uri of the play audio request. Currently only Wave file (.wav) format
6868 * audio prompts are supported. More specifically, the audio content in the wave file must
6969 * be mono (single-channel), 16-bit samples with a 16,000 (16KHz) sampling rate.
7070 * @param playAudioOptions Options for play audio.
7171 * @throws CallingServerErrorException thrown if the request is rejected by server.
7272 * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
73- * @return the response payload for play audio operation.
73+ * @return Response payload for play audio operation.
7474 */
7575 @ ServiceMethod (returns = ReturnType .SINGLE )
7676 public PlayAudioResult playAudio (String audioFileUri , PlayAudioOptions playAudioOptions ) {
7777 return callConnectionAsync .playAudioInternal (audioFileUri , playAudioOptions ).block ();
7878 }
7979
8080 /**
81- * Play audio in a call.
81+ * Play audio in the call.
8282 *
8383 * @param audioFileUri The media resource uri of the play audio request. Currently only Wave file (.wav) format
8484 * audio prompts are supported. More specifically, the audio content in the wave file must
@@ -87,7 +87,7 @@ public PlayAudioResult playAudio(String audioFileUri, PlayAudioOptions playAudio
8787 * @param context A {@link Context} representing the request context.
8888 * @throws CallingServerErrorException thrown if the request is rejected by server.
8989 * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
90- * @return the response payload for play audio operation.
90+ * @return Response payload for play audio operation.
9191 */
9292 @ ServiceMethod (returns = ReturnType .SINGLE )
9393 public Response <PlayAudioResult > playAudioWithResponse (
@@ -100,7 +100,7 @@ public Response<PlayAudioResult> playAudioWithResponse(
100100 }
101101
102102 /**
103- * Disconnect the current caller in a group-call or end a p2p- call.
103+ * Disconnect from a call.
104104 *
105105 * @throws CallingServerErrorException thrown if the request is rejected by server.
106106 * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
@@ -111,12 +111,12 @@ public void hangup() {
111111 }
112112
113113 /**
114- * Disconnect the current caller in a group-call or end a p2p- call.
114+ * Disconnect from a call.
115115 *
116116 * @param context A {@link Context} representing the request context.
117117 * @throws CallingServerErrorException thrown if the request is rejected by server.
118118 * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
119- * @return response for a successful hangup request.
119+ * @return Response for a successful hangup request.
120120 */
121121 @ ServiceMethod (returns = ReturnType .SINGLE )
122122 public Response <Void > hangupWithResponse (final Context context ) {
@@ -130,7 +130,7 @@ public Response<Void> hangupWithResponse(final Context context) {
130130 * communications related to this operation
131131 * @throws CallingServerErrorException thrown if the request is rejected by server.
132132 * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
133- * @return response for a successful cancel all media operations request.
133+ * @return Response for a successful cancel all media operations request.
134134 */
135135 @ ServiceMethod (returns = ReturnType .SINGLE )
136136 public CancelAllMediaOperationsResult cancelAllMediaOperations (String operationContext ) {
@@ -145,7 +145,7 @@ public CancelAllMediaOperationsResult cancelAllMediaOperations(String operationC
145145 * @param context A {@link Context} representing the request context.
146146 * @throws CallingServerErrorException thrown if the request is rejected by server.
147147 * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
148- * @return response for a successful cancel all media operations request.
148+ * @return Response for a successful cancel all media operations request.
149149 */
150150 @ ServiceMethod (returns = ReturnType .SINGLE )
151151 public Response <CancelAllMediaOperationsResult > cancelAllMediaOperationsWithResponse (
@@ -158,12 +158,12 @@ public Response<CancelAllMediaOperationsResult> cancelAllMediaOperationsWithResp
158158 * Add a participant to the call.
159159 *
160160 * @param participant Added participant.
161- * @param alternateCallerId The phone number to use when adding a phone number participant.
162- * @param operationContext The value to identify context of the operation. This is used to co-relate other
161+ * @param alternateCallerId Phone number to use when adding a phone number participant.
162+ * @param operationContext Value to identify context of the operation. This is used to co-relate other
163163 * communications related to this operation
164164 * @throws CallingServerErrorException thrown if the request is rejected by server.
165165 * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
166- * @return response for a successful add participant request.
166+ * @return Response for a successful add participant request.
167167 */
168168 @ ServiceMethod (returns = ReturnType .SINGLE )
169169 public AddParticipantResult addParticipant (
@@ -177,13 +177,13 @@ public AddParticipantResult addParticipant(
177177 * Add a participant to the call.
178178 *
179179 * @param participant Added participant.
180- * @param alternateCallerId The phone number to use when adding a phone number participant.
181- * @param operationContext The value to identify context of the operation. This is used to co-relate other
180+ * @param alternateCallerId Phone number to use when adding a phone number participant.
181+ * @param operationContext Value to identify context of the operation. This is used to co-relate other
182182 * communications related to this operation
183- * @param context A {@link Context} representing the request context.
183+ * @param context {@link Context} representing the request context.
184184 * @throws CallingServerErrorException thrown if the request is rejected by server.
185185 * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
186- * @return response for a successful add participant request.
186+ * @return Response for a successful add participant request.
187187 */
188188 @ ServiceMethod (returns = ReturnType .SINGLE )
189189 public Response <AddParticipantResult > addParticipantWithResponse (
@@ -211,10 +211,10 @@ public void removeParticipant(String participantId) {
211211 * Remove a participant from the call.
212212 *
213213 * @param participantId Participant id.
214- * @param context A {@link Context} representing the request context.
214+ * @param context {@link Context} representing the request context.
215215 * @throws CallingServerErrorException thrown if the request is rejected by server.
216216 * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
217- * @return response for a successful remove participant request.
217+ * @return Response for a successful remove participant request.
218218 */
219219 @ ServiceMethod (returns = ReturnType .SINGLE )
220220 public Response <Void > removeParticipantWithResponse (String participantId , final Context context ) {
0 commit comments