Skip to content

GA5 Javadoc Issues #45432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
v-dharmarajv merged 2 commits into from
May 21, 2025
Merged

GA5 Javadoc Issues #45432

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86f9936
Fixed Javadoc issues in StreamingData.java & TranscriptionOptions.java
v-saasomani May 21, 2025
a3b93cd
Renamed MediaStreamingContent class to MediaStreamingContentType. Ren…
v-saasomani May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Fixed Javadoc issues in StreamingData.java & TranscriptionOptions.java
  • Loading branch information
@v-saasomani
v-saasomani committed May 21, 2025
commit 86f99369acdb979339eebe77a42149b85e6fb700
9 changes: 5 additions & 4 deletions ...automation/src/main/java/com/azure/communication/callautomation/models/StreamingData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ public abstract class StreamingData {

/**
* Creates an instance of {@link StreamingData}.
* @param streamingDataKind The kind of streaming data.
*/
public StreamingData(StreamingDataKind streamingDataKind) {
this.streamingDataKind = streamingDataKind;
Expand All @@ -44,7 +45,7 @@ public StreamingDataKind getStreamingDataKind() {
* Parses a base64 encoded string into a StreamingData object,
* which can be one of the following subtypes: AudioData, AudioMetadata, TranscriptionData, or TranscriptionMetadata.
* @param data The base64 string represents streaming data that will be converted into the appropriate subtype of StreamingData.
* @return StreamingData
* @return StreamingData
* @throws RuntimeException Throws a RuntimeException if the provided base64 string does not correspond to a supported data type for the specified Kind.
*/
public static StreamingData parse(String data) {
Expand All @@ -55,7 +56,7 @@ public static StreamingData parse(String data) {
* Parses a base64 encoded string into a StreamingData object,
* which can be one of the following subtypes: AudioData, AudioMetadata, TranscriptionData, or TranscriptionMetadata.
* @param <T> Subtypes of StreamingData ex. AudioData, AudioMetadata, TranscriptionData, TranscriptionMetadata
* @param data The base64 string represents streaming data that will be converted into the appropriate subtype of StreamingData.
* @param data The base64 string represents streaming data that will be converted into the appropriate subtype of StreamingData.
* @param type type of the streamindata ex. AudioData, AudioMetadata, TranscriptionData, TranscriptionMetadata
* @return Subtypes of StreamingData
* @throws RuntimeException Throws a NotSupportedException if the provided base64 string does not correspond
Expand All @@ -67,8 +68,8 @@ public static <T extends StreamingData> T parse(String data, Class<T> type) {
}

/**
*
* @param data the base64 string
*
* @param data the base64 string
* @return the StreamingData
*/
private static StreamingData parseStreamingData(String data) {
Expand Down
14 changes: 6 additions & 8 deletions ...ion/src/main/java/com/azure/communication/callautomation/models/TranscriptionOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,7 @@ public final class TranscriptionOptions {
/**
* Creates a new instance of MediaStreamingConfiguration
* @param transportUrl - The Transport URL
* @param transportType - Transport type
* @param locale - Locale
* @param startTranscription - Start Transcription
*/
public TranscriptionOptions(String transportUrl, String locale) {
this.transportUrl = transportUrl;
Expand Down Expand Up @@ -92,7 +90,7 @@ public boolean getStartTranscription() {
/**
* Get the startTranscription property: Indicates whether the transcription should start immediately after the call
* is answered.
*
*
* @return the startTranscription value.
*/
public Boolean isStartTranscription() {
Expand All @@ -102,7 +100,7 @@ public Boolean isStartTranscription() {
/**
* Set the startTranscription property: Indicates whether the transcription should start immediately after the call
* is answered.
*
*
* @param startTranscription the startTranscription value to set.
* @return the TranscriptionOptions object itself.
*/
Expand All @@ -113,7 +111,7 @@ public TranscriptionOptions setStartTranscription(Boolean startTranscription) {

/**
* Get the speechRecognitionModelEndpointId property: Endpoint where the custom model was deployed.
*
*
* @return the speechRecognitionModelEndpointId value.
*/
public String getSpeechRecognitionModelEndpointId() {
Expand All @@ -122,7 +120,7 @@ public String getSpeechRecognitionModelEndpointId() {

/**
* Set the speechRecognitionModelEndpointId property: Endpoint where the custom model was deployed.
*
*
* @param speechRecognitionModelEndpointId the speechRecognitionModelEndpointId value to set.
* @return the TranscriptionOptions object itself.
*/
Expand All @@ -133,7 +131,7 @@ public TranscriptionOptions setSpeechRecognitionModelEndpointId(String speechRec

/**
* Get the enableIntermediateResults property: Enables intermediate results for the transcribed speech.
*
*
* @return the enableIntermediateResults value.
*/
public Boolean isIntermediateResultsEnabled() {
Expand All @@ -142,7 +140,7 @@ public Boolean isIntermediateResultsEnabled() {

/**
* Set the enableIntermediateResults property: Enables intermediate results for the transcribed speech.
*
*
* @param enableIntermediateResults the enableIntermediateResults value to set.
* @return the TranscriptionOptions object itself.
*/
Expand Down