Interface CommonPromptOptionsService


  • public interface CommonPromptOptionsService
    Internal service for retrieving details regarding various common options for prompt configuration parameters. See e.g. CommonAudioFormat, CommonEffortLevel, etc.
    Since:
    8.5.0
    • Method Detail

      • findIconForCommonPromptTask

        IGuiIcon findIconForCommonPromptTask​(String commonPromptTask)
        Finds the icon for a common propt task given by its name.
        Parameters:
        commonPromptTask - The name of the common prompt task.
        Returns:
        The icon.
      • findIconForCommonTranscriptionFormat

        IGuiIcon findIconForCommonTranscriptionFormat​(String commonTranscriptionFormat)
        Finds the icon for a common transcription format given by its name.
        Parameters:
        commonTranscriptionFormat - The name of the common transcription format.
        Returns:
        The icon.
      • findMimeTypeForImageFormat

        String findMimeTypeForImageFormat​(String imageFormat)
        Finds the MIME type for a common image format given by its name.
        Parameters:
        imageFormat - The name of the common image format.
        Returns:
        The MIME type.
      • localizeAspectRatioDescription

        String localizeAspectRatioDescription​(Locale locale,
                                              String commonAspectRatio)
        Localizes the description for a common aspect ratio given by its name.
        Parameters:
        locale - The locale for which to localize the description.
        commonAspectRatio - The common aspect ratio constant.
        Returns:
        The localized description for the given common aspect ratio.
      • localizeAspectRatioLabel

        String localizeAspectRatioLabel​(Locale locale,
                                        String commonAspectRatio)
        Localizes the label for a common aspect ratio given by its name.
        Parameters:
        locale - The locale for which to localize the label.
        commonAspectRatio - The common aspect ratio constant.
        Returns:
        The localized label for the given common aspect ratio.
      • localizeAudioFormatDescription

        String localizeAudioFormatDescription​(Locale locale,
                                              String commonAudioFormat)
        Localizes the description for a common audio format given by its name.
        Parameters:
        locale - The locale for which to localize the description.
        commonAudioFormat - The name of the common audio format.
        Returns:
        The localized description.
      • localizeAudioFormatLabel

        String localizeAudioFormatLabel​(Locale locale,
                                        String commonAudioFormat)
        Localizes the label for a common audio format given by its name.
        Parameters:
        locale - The locale for which to localize the label.
        commonAudioFormat - The name of the common audio format.
        Returns:
        The localized label.
      • localizeDescriptionForCommonVideoFormat

        String localizeDescriptionForCommonVideoFormat​(Locale locale,
                                                       String commonVideoFormat)
        Localizes the description for a common video format given by its name.
        Parameters:
        locale - The locale for which to localize the description.
        commonVideoFormat - The name of the common video format.
        Returns:
        The localized description.
      • localizeEffortLevelDescription

        String localizeEffortLevelDescription​(Locale locale,
                                              String commonEffortLevel)
        Localizes the label for a common effort level given by its name.
        Parameters:
        locale - The locale for which to localize the label.
        commonEffortLevel - The name of the common effort level.
        Returns:
        The localized label.
      • localizeEffortLevelLabel

        String localizeEffortLevelLabel​(Locale locale,
                                        String commonEffortLevel)
        Localizes the label for a common effort level given by its name.
        Parameters:
        locale - The locale for which to localize the label.
        commonEffortLevel - The name of the common effort level.
        Returns:
        The localized label.
      • localizeImageBackgroundDescription

        String localizeImageBackgroundDescription​(Locale locale,
                                                  String commonImageBackground)
        Localizes the description for a common image background given by its name.
        Parameters:
        locale - The locale for which to localize the description.
        commonImageBackground - The name of the common image background.
        Returns:
        The localized description.
      • localizeImageBackgroundLabel

        String localizeImageBackgroundLabel​(Locale locale,
                                            String commonImageBackground)
        Localizes the label for a common image background given by its name.
        Parameters:
        locale - The locale for which to localize the label.
        commonImageBackground - The name of the common image background.
        Returns:
        The localized label.
      • localizeImageFormatDescription

        String localizeImageFormatDescription​(Locale locale,
                                              String commonImageFormat)
        Localizes the description for a common image format given by its name.
        Parameters:
        locale - The locale for which to localize the description.
        commonImageFormat - The name of the common image format.
        Returns:
        The localized description.
      • localizeImageFormatLabel

        String localizeImageFormatLabel​(Locale locale,
                                        String commonImageFormat)
        Localizes the label for a common image format given by its name.
        Parameters:
        locale - The locale for which to localize the label.
        commonImageFormat - The name of the common image format.
        Returns:
        The localized label.
      • localizeLabelForCommonVideoFormat

        String localizeLabelForCommonVideoFormat​(Locale locale,
                                                 String commonVideoFormat)
        Localizes the label for a common video format given by its name.
        Parameters:
        locale - The locale for which to localize the label.
        commonVideoFormat - The name of the common video format.
        Returns:
        The localized label.
      • localizePromptTaskDescription

        String localizePromptTaskDescription​(Locale locale,
                                             String commonPromptTask)
        Localizes the description for a common prompt task given by its name.
        Parameters:
        locale - The locale for which to localize the description.
        commonPromptTask - The name of the common prompt task.
        Returns:
        The localized description.
      • localizePromptTaskLabel

        String localizePromptTaskLabel​(Locale locale,
                                       String commonPromptTask)
        Localizes the label for a common prompt task given by its name.
        Parameters:
        locale - The locale for which to localize the label.
        commonPromptTask - The name of the common prompt task.
        Returns:
        The localized label.
      • localizeTranscriptionFormatDescription

        String localizeTranscriptionFormatDescription​(Locale locale,
                                                      String commonTranscriptionFormat)
        Localizes the description for a common transcription format given by its name.
        Parameters:
        locale - The locale for which to localize the description.
        commonTranscriptionFormat - The name of the common transcription format.
        Returns:
        The localized description.
      • localizeTranscriptionFormatLabel

        String localizeTranscriptionFormatLabel​(Locale locale,
                                                String commonTranscriptionFormat)
        Localizes the label for a common transcription format given by its name.
        Parameters:
        locale - The locale for which to localize the label.
        commonTranscriptionFormat - The name of the common transcription format.
        Returns:
        The localized label.