From c75cbda9c2302dfd2c176f103e89ef24f0527269 Mon Sep 17 00:00:00 2001 From: zt147369 Date: Thu, 11 May 2023 03:59:09 +0000 Subject: [PATCH] =?UTF-8?q?=E6=8C=87=E5=AE=9Adensity=E6=9F=A5=E7=9C=8B?= =?UTF-8?q?=E8=B5=84=E6=BA=90?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: zt147369 --- .../apis/js-apis-resource-manager.md | 521 +++++++++++++++++- 1 file changed, 515 insertions(+), 6 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md b/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md index 82e108e21d..5610c832ae 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md @@ -640,7 +640,6 @@ getStringArrayValue(resource: Resource): Promise<Array<string>> } ``` - ### getMediaContent9+ getMediaContent(resId: number, callback: AsyncCallback<Uint8Array>): void @@ -680,6 +679,45 @@ getMediaContent(resId: number, callback: AsyncCallback<Uint8Array>): void } ``` +### getMediaContent10+ + +getMediaContent(resId: number, density: number, callback: AsyncCallback<Uint8Array>): void + +用户获取指定资源ID对应的指定屏幕密度媒体文件内容，使用callback形式返回字节数组。 + +**系统能力**：SystemCapability.Global.ResourceManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ------------------ | +| resId | number | 是 | 资源ID值 | +| [density](#screendensity) | number | 是 | 资源获取需要的屏幕密度，0表示默认屏幕密度 | +| callback | AsyncCallback<Uint8Array> | 是 | 异步回调，用于返回获取的媒体文件内容 | + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001001 | If the resId invalid. | +| 9001002 | If the resource not found by resId. | + +**示例：** + ```ts + try { + this.context.resourceManager.getMediaContent($r('app.media.test').id, 120, (error, value) => { + if (error != null) { + console.error(`callback getMediaContent failed, error code: ${error.code}, message: ${error.message}.`); + } else { + let media = value; + } + }); + } catch (error) { + console.error(`callback getMediaContent failed, error code: ${error.code}, message: ${error.message}.`) + } + ``` ### getMediaContent9+ @@ -723,6 +761,49 @@ getMediaContent(resId: number): Promise<Uint8Array> } ``` +### getMediaContent10+ + +getMediaContent(resId: number, density: number): Promise<Uint8Array> + +用户获取指定资源ID对应的指定屏幕密度媒体文件内容，使用Promise形式返回字节数组。 + +**系统能力**：SystemCapability.Global.ResourceManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----- | +| resId | number | 是 | 资源ID值 | +| [density](#screendensity) | number | 是 | 资源获取需要的屏幕密度，0表示默认屏幕密度 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------- | -------------- | +| Promise<Uint8Array> | 资源ID值对应的媒体文件内容 | + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001001 | If the resId invalid. | +| 9001002 | If the resource not found by resId. | + +**示例：** + ```ts + try { + this.context.resourceManager.getMediaContent($r('app.media.test').id, 120).then(value => { + let media = value; + }).catch(error => { + console.error(`promise getMediaContent failed, error code: ${error.code}, message: ${error.message}.`); + }); + } catch (error) { + console.error(`promise getMediaContent failed, error code: ${error.code}, message: ${error.message}.`) + } + ``` + ### getMediaContent9+ getMediaContent(resource: Resource, callback: AsyncCallback<Uint8Array>): void @@ -767,6 +848,51 @@ getMediaContent(resource: Resource, callback: AsyncCallback<Uint8Array>): } ``` +### getMediaContent10+ + +getMediaContent(resource: Resource, density: number, callback: AsyncCallback<Uint8Array>): void + +用户获取指定resource对象对应的指定屏幕密度媒体文件内容，使用callback形式返回字节数组。 + +**系统能力**：SystemCapability.Global.ResourceManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ------------------ | +| resource | [Resource](#resource9) | 是 | 资源信息 | +| [density](#screendensity) | number | 是 | 资源获取需要的屏幕密度，0表示默认屏幕密度 | +| callback | AsyncCallback<Uint8Array> | 是 | 异步回调，用于返回获取的媒体文件内容 | + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001001 | If the resId invalid. | +| 9001002 | If the resource not found by resId. | + +**示例：** + ```ts + let resource = { + bundleName: "com.example.myapplication", + moduleName: "entry", + id: $r('app.media.test').id + }; + try { + this.context.resourceManager.getMediaContent(resource, 120, (error, value) => { + if (error != null) { + console.error(`callback getMediaContent failed, error code: ${error.code}, message: ${error.message}.`); + } else { + let media = value; + } + }); + } catch (error) { + console.error(`callback getMediaContent failed, error code: ${error.code}, message: ${error.message}.`) + } + ``` + ### getMediaContent9+ getMediaContent(resource: Resource): Promise<Uint8Array> @@ -814,6 +940,53 @@ getMediaContent(resource: Resource): Promise<Uint8Array> } ``` +### getMediaContent10+ + +getMediaContent(resource: Resource, density: number): Promise<Uint8Array> + +用户获取指定resource对象对应的指定屏幕密度媒体文件内容，使用Promise形式返回字节数组。 + +**系统能力**：SystemCapability.Global.ResourceManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ---- | +| resource | [Resource](#resource9) | 是 | 资源信息 | +| [density](#screendensity) | number | 是 | 资源获取需要的屏幕密度，0表示默认屏幕密度 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------- | ------------------- | +| Promise<Uint8Array> | resource对象对应的媒体文件内容 | + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001001 | If the resId invalid. | +| 9001002 | If the resource not found by resId. | + +**示例：** + ```ts + let resource = { + bundleName: "com.example.myapplication", + moduleName: "entry", + id: $r('app.media.test').id + }; + try { + this.context.resourceManager.getMediaContent(resource, 120).then(value => { + let media = value; + }).catch(error => { + console.error(`promise getMediaContent failed, error code: ${error.code}, message: ${error.message}.`); + }); + } catch (error) { + console.error(`promise getMediaContent failed, error code: ${error.code}, message: ${error.message}.`) + } + ``` ### getMediaContentBase649+ @@ -854,6 +1027,45 @@ getMediaContentBase64(resId: number, callback: AsyncCallback<string>): voi } ``` +### getMediaContentBase6410+ + +getMediaContentBase64(resId: number, density: number, callback: AsyncCallback<string>): void + +用户获取指定资源ID对应的指定屏幕密度图片资源Base64编码，使用callback形式返回字符串。 + +**系统能力**：SystemCapability.Global.ResourceManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------ | +| resId | number | 是 | 资源ID值 | +| [density](#screendensity) | number | 是 | 资源获取需要的屏幕密度，0表示默认屏幕密度 | +| callback | AsyncCallback<string> | 是 | 异步回调，用于返回获取的图片资源Base64编码 | + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001001 | If the resId invalid. | +| 9001002 | If the resource not found by resId. | + +**示例：** + ```ts + try { + this.context.resourceManager.getMediaContentBase64($r('app.media.test').id, 120, (error, value) => { + if (error != null) { + console.error(`callback getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`); + } else { + let media = value; + } + }); + } catch (error) { + console.error(`callback getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`) + } + ``` ### getMediaContentBase649+ @@ -894,7 +1106,50 @@ getMediaContentBase64(resId: number): Promise<string> }); } catch (error) { console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`) - } + } + ``` + +### getMediaContentBase6410+ + +getMediaContentBase64(resId: number, density: number): Promise<string> + +用户获取指定资源ID对应的指定屏幕密度图片资源Base64编码，使用Promise形式返回字符串。 + +**系统能力**：SystemCapability.Global.ResourceManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----- | +| resId | number | 是 | 资源ID值 | +| [density](#screendensity) | number | 是 | 资源获取需要的屏幕密度，0表示默认屏幕密度 | + +**返回值：** + +| 类型 | 说明 | +| --------------------- | -------------------- | +| Promise<string> | 资源ID值对应的图片资源Base64编码 | + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001001 | If the resId invalid. | +| 9001002 | If the resource not found by resId. | + +**示例：** + ```ts + try { + this.context.resourceManager.getMediaContentBase64($r('app.media.test').id, 120).then(value => { + let media = value; + }).catch(error => { + console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`); + }); + } catch (error) { + console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`) + } ``` ### getMediaContentBase649+ @@ -941,6 +1196,51 @@ getMediaContentBase64(resource: Resource, callback: AsyncCallback<string>) } ``` +### getMediaContentBase6410+ + +getMediaContentBase64(resource: Resource, density: number, callback: AsyncCallback<string>): void + +用户获取指定resource对象对应的指定屏幕密度图片资源Base64编码，使用callback形式返回字符串。 + +**系统能力**：SystemCapability.Global.ResourceManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------ | +| resource | [Resource](#resource9) | 是 | 资源信息 | +| [density](#screendensity) | number | 是 | 资源获取需要的屏幕密度，0表示默认屏幕密度 | +| callback | AsyncCallback<string> | 是 | 异步回调，用于返回获取的图片资源Base64编码 | + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001001 | If the resId invalid. | +| 9001002 | If the resource not found by resId. | + +**示例：** + ```ts + let resource = { + bundleName: "com.example.myapplication", + moduleName: "entry", + id: $r('app.media.test').id + }; + try { + this.context.resourceManager.getMediaContentBase64(resource, 120, (error, value) => { + if (error != null) { + console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`); + } else { + let media = value; + } + }); + } catch (error) { + console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`) + } + ``` + ### getMediaContentBase649+ getMediaContentBase64(resource: Resource): Promise<string> @@ -988,6 +1288,53 @@ getMediaContentBase64(resource: Resource): Promise<string> } ``` +### getMediaContentBase6410+ + +getMediaContentBase64(resource: Resource, density: number): Promise<string> + +用户获取指定resource对象对应的指定屏幕密度图片资源Base64编码，使用Promise形式返回字符串。 + +**系统能力**：SystemCapability.Global.ResourceManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ---- | +| resource | [Resource](#resource9) | 是 | 资源信息 | +| [density](#screendensity) | number | 是 | 资源获取需要的屏幕密度，0表示默认屏幕密度 | + +**返回值：** + +| 类型 | 说明 | +| --------------------- | ------------------------- | +| Promise<string> | resource对象对应的图片资源Base64编码 | + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001001 | If the resId invalid. | +| 9001002 | If the resource not found by resId. | + +**示例：** + ```ts + let resource = { + bundleName: "com.example.myapplication", + moduleName: "entry", + id: $r('app.media.test').id + }; + try { + this.context.resourceManager.getMediaContentBase64(resource, 120).then(value => { + let media = value; + }).catch(error => { + console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`); + }); + } catch (error) { + console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`) + } + ``` ### getConfiguration @@ -1789,7 +2136,6 @@ getMediaByName(resName: string, callback: AsyncCallback<Uint8Array>): void | -------- | ---------------------------------------- | | 9001003 | If the resName invalid. | | 9001004 | If the resource not found by resName. | -| 9001006 | If the resource re-ref too much. | **示例：** ```ts @@ -1806,6 +2152,46 @@ getMediaByName(resName: string, callback: AsyncCallback<Uint8Array>): void } ``` +### getMediaByName10+ + +getMediaByName(resName: string, density: number, callback: AsyncCallback<Uint8Array>): void + +用户获取指定资源ID对应的指定屏幕密度媒体文件内容，使用callback形式返回字节数组。 + +**系统能力**：SystemCapability.Global.ResourceManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ------------------ | +| resName | string | 是 | 资源名称 | +| [density](#screendensity) | number | 是 | 资源获取需要的屏幕密度，0表示默认屏幕密度 | +| callback | AsyncCallback<Uint8Array> | 是 | 异步回调，用于返回获取的媒体文件内容 | + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001003 | If the resName invalid. | +| 9001004 | If the resource not found by resName. | + +**示例：** + ```ts + try { + this.context.resourceManager.getMediaByName("test", 120, (error, value) => { + if (error != null) { + console.error(`callback getMediaByName failed, error code: ${error.code}, message: ${error.message}.`); + } else { + let media = value; + } + }); + } catch (error) { + console.error(`callback getMediaByName failed, error code: ${error.code}, message: ${error.message}.`) + } + ``` + ### getMediaByName9+ getMediaByName(resName: string): Promise<Uint8Array> @@ -1834,7 +2220,6 @@ getMediaByName(resName: string): Promise<Uint8Array> | -------- | ---------------------------------------- | | 9001003 | If the resName invalid. | | 9001004 | If the resource not found by resName. | -| 9001006 | If the resource re-ref too much. | **示例：** ```ts @@ -1849,6 +2234,49 @@ getMediaByName(resName: string): Promise<Uint8Array> } ``` +### getMediaByName10+ + +getMediaByName(resName: string, density: number): Promise<Uint8Array> + +用户获取指定资源名称对应的指定屏幕密度媒体文件内容，使用Promise形式返回字节数组。 + +**系统能力**：SystemCapability.Global.ResourceManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---- | +| resName | string | 是 | 资源名称 | +| [density](#screendensity) | number | 是 | 资源获取需要的屏幕密度，0表示默认屏幕密度 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------- | ------------- | +| Promise<Uint8Array> | 资源名称对应的媒体文件内容 | + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001003 | If the resName invalid. | +| 9001004 | If the resource not found by resName. | + +**示例：** + ```ts + try { + this.context.resourceManager.getMediaByName("test", 120).then(value => { + let media = value; + }).catch(error => { + console.error(`promise getMediaByName failed, error code: ${error.code}, message: ${error.message}.`); + }); + } catch (error) { + console.error(`promise getMediaByName failed, error code: ${error.code}, message: ${error.message}.`) + } + ``` + ### getMediaBase64ByName9+ getMediaBase64ByName(resName: string, callback: AsyncCallback<string>): void @@ -1872,7 +2300,6 @@ getMediaBase64ByName(resName: string, callback: AsyncCallback<string>): vo | -------- | ---------------------------------------- | | 9001003 | If the resName invalid. | | 9001004 | If the resource not found by resName. | -| 9001006 | If the resource re-ref too much. | **示例：** ```ts @@ -1889,6 +2316,46 @@ getMediaBase64ByName(resName: string, callback: AsyncCallback<string>): vo } ``` +### getMediaBase64ByName10+ + +getMediaBase64ByName(resName: string, density: number, callback: AsyncCallback<string>): void + +用户获取指定资源名称对应的指定屏幕密度图片资源Base64编码，使用callback形式返回字符串。 + +**系统能力**：SystemCapability.Global.ResourceManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------ | +| resName | string | 是 | 资源名称 | +| [density](#screendensity) | number | 是 | 资源获取需要的屏幕密度，0表示默认屏幕密度 | +| callback | AsyncCallback<string> | 是 | 异步回调，用于返回获取的图片资源Base64编码 | + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001003 | If the resName invalid. | +| 9001004 | If the resource not found by resName. | + +**示例：** + ```ts + try { + this.context.resourceManager.getMediaBase64ByName("test", 120, (error, value) => { + if (error != null) { + console.error(`callback getMediaBase64ByName failed, error code: ${error.code}, message: ${error.message}.`); + } else { + let media = value; + } + }); + } catch (error) { + console.error(`callback getMediaBase64ByName failed, error code: ${error.code}, message: ${error.message}.`) + } + ``` + ### getMediaBase64ByName9+ getMediaBase64ByName(resName: string): Promise<string> @@ -1917,7 +2384,6 @@ getMediaBase64ByName(resName: string): Promise<string> | -------- | ---------------------------------------- | | 9001003 | If the resName invalid. | | 9001004 | If the resource not found by resName. | -| 9001006 | If the resource re-ref too much. | **示例：** ```ts @@ -1932,6 +2398,49 @@ getMediaBase64ByName(resName: string): Promise<string> } ``` +### getMediaBase64ByName10+ + +getMediaBase64ByName(resName: string, density: number): Promise<string> + +用户获取指定资源名称对应的指定屏幕密度图片资源Base64编码，使用Promise形式返回字符串。 + +**系统能力**：SystemCapability.Global.ResourceManager + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---- | +| resName | string | 是 | 资源名称 | +| [density](#screendensity) | number | 是 | 资源获取需要的屏幕密度，0表示默认屏幕密度 | + +**返回值：** + +| 类型 | 说明 | +| --------------------- | ------------------- | +| Promise<string> | 资源名称对应的图片资源Base64编码 | + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +**错误码：** + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001003 | If the resName invalid. | +| 9001004 | If the resource not found by resName. | + +**示例：** + ```ts + try { + this.context.resourceManager.getMediaBase64ByName("test", 120).then(value => { + let media = value; + }).catch(error => { + console.error(`promise getMediaBase64ByName failed, error code: ${error.code}, message: ${error.message}.`); + }); + } catch (error) { + console.error(`promise getMediaBase64ByName failed, error code: ${error.code}, message: ${error.message}.`) + } + ``` + ### getPluralStringByName9+ getPluralStringByName(resName: string, num: number, callback: AsyncCallback<string>): void -- GitLab