commonMain.spi.AudioToSilkService.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mirai-core-api-common Show documentation

Mirai API module

There is a newer version: 2.12.3

Show newest version

/*
 * Copyright 2019-2021 Mamoe Technologies and contributors.
 *
 * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
 * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
 *
 * https://github.com/mamoe/mirai/blob/dev/LICENSE
 */

package net.mamoe.mirai.spi

import net.mamoe.mirai.utils.*
import java.io.IOException

/**
 * 将源音频文件转换为 silk v3 with tencent 格式
 *
 * @since 2.8.0
 */
@MiraiExperimentalApi
public interface AudioToSilkService : BaseService {
    /**
     * implementation note:
     *
     * 如果返回值为转换后的资源文件:
     *
     * 如果 [ExternalResource.isAutoClose], 需要关闭 [source],
     * 返回的 [ExternalResource] 的 [ExternalResource.isAutoClose] 必须为 `true`
     *
     * 特别的, 如果该方法体抛出了一个错误, 如果 [ExternalResource.isAutoClose], 需要关闭 [source]
     *
     * @see [withAutoClose]
     * @see [runAutoClose]
     * @see [useAutoClose]
     */
    @Throws(IOException::class)
    public suspend fun convert(source: ExternalResource): ExternalResource

    @MiraiExperimentalApi
    public companion object : AudioToSilkService {
        private val loader = SPIServiceLoader(object : AudioToSilkService {
            override suspend fun convert(source: ExternalResource): ExternalResource = source
        }, AudioToSilkService::class.java)

        @Suppress("BlockingMethodInNonBlockingContext")
        @Throws(IOException::class)
        override suspend fun convert(source: ExternalResource): ExternalResource {
            return loader.service.convert(source)
        }

        @JvmStatic
        public fun setService(service: AudioToSilkService) {
            loader.service = service
        }
    }
}