namespace Funique
{
    /// <summary>
    /// String related utility methods <br />
    /// ------------------------------------------------ <br />
    /// 字串相關幫助函式
    /// </summary>
    public interface IToolStringExtension
    {
        /// <summary>
        /// Remove only the time label <br />
        /// ------------------------------------------------ <br />
        /// 只移除 檔案名稱中的時間標籤
        /// </summary>
        /// <param name="videoSourceName"></param>
        /// <returns></returns>
        string FilterVideoName(string videoSourceName);
        /// <summary>
        /// Get the video name time by file name <br />
        /// ------------------------------------------------ <br />
        /// 得到檔案名稱中時間標籤所表示的時間
        /// </summary>
        /// <param name="VideoSourceName"></param>
        /// <returns>Total Second</returns>
        float FilterVideoTime(string VideoSourceName);
        /// <summary>
        /// Translate the time string to double data <br />
        /// ------------------------------------------------ <br />
        /// 將時間字串轉換成 Double 精準資料
        /// </summary>
        /// <example>
        /// Example: 1m30s -> 90.0 <br />
        /// </example>
        /// <param name="timeString"></param>
        /// <returns></returns>
        double TranslateTime(string timeString);
        /// <summary>
        /// Filter time, extension, but keep stereo label <br />
        /// ------------------------------------------------ <br />
        /// 過濾時間. 副檔名, 但是留下劇院標籤
        /// </summary>
        /// <example>
        /// test_name_3dv_5h2m1s.mp4 => test_name_3dv
        /// </example>
        /// <param name="VideoSourceName"></param>
        /// <returns></returns>
        string FilterBtnName(string VideoSourceName);
        /// <summary>
        /// Added the time string in the end of the filter file name <br />
        /// ------------------------------------------------ <br />
        /// 加上時間字串 在 過濾檔案標題之結尾
        /// </summary>
        /// <param name="name">Filter name</param>
        /// <param name="time">Total Second</param>
        /// <returns></returns>
        string MergeTime(string name, double time);
        /// <summary>
        /// Detect stereo mode from file name <br />
        /// ------------------------------------------------ <br />
        /// 偵測檔案標籤中所要表示的劇院模式
        /// </summary>
        /// <param name="videoFilterName"></param>
        /// <returns></returns>
        string DetectStereoMode(string videoFilterName);
    }
}