MediaClient

मीडिया ऑपरेशनों के लिए Client

यह Client, X API के मीडिया endpoints के साथ इंटरैक्ट करने के लिए मेथड उपलब्ध कराता है। यह सभी मीडिया-संबंधित operations के लिए authentication, request formatting और response parsing को संभालता है।

zeUpload](/xdks/typescript/reference/classes/MediaClient#finalizeupload)

• initializeUpload
• createSubtitles
• deleteSubtitles

​

कंस्ट्रक्टर्स

​

constructor

• new MediaClient(client): MediaClient

एक नया मीडिया क्लाइंट instance बनाता है

​

पैरामीटर

नाम	type	विवरण
client	Client	मुख्य X API क्लाइंट का इंस्टेंस

​

रिटर्न

MediaClient

​

यहाँ परिभाषित

media/client.ts:250

​

मेथड्स

​

getByKey

▸ getByKey(mediaKey, options): Promise<Response>

media key से Media प्राप्त करें इसके media key के आधार पर किसी विशिष्ट Media फ़ाइल का विवरण प्राप्त करता है।

​

पैरामीटर

नाम	type	विवरण
mediaKey	string	एक Media Key।
options	GetByKeyOptions & { requestOptions: { raw: true } }	-

​

रिटर्न

Promise<Response>

API response पर resolve होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response

​

इसमें परिभाषित

media/client.ts:295

▸ getByKey(mediaKey, options?): Promise<Get2MediaMediaKeyResponse>

​

पैरामीटर

नाम	प्रकार
mediaKey	string
options?	GetByKeyOptions

​

रिटर्न करता है

Promise<Get2MediaMediaKeyResponse>

​

यहाँ परिभाषित

media/client.ts:308

---

​

getUploadStatus

▸ getUploadStatus(mediaId, options): Promise<Response>

Media अपलोड की स्थिति प्राप्त करें किसी Media अपलोड की स्थिति उसकी ID से प्राप्त करता है।

​

पैरामीटर

नाम	Type	विवरण
mediaId	string	अनुरोधित मीडिया अपलोड स्थिति के लिए मीडिया id।
options	GetUploadStatusOptions & { requestOptions: { raw: true } }	-

​

रिटर्न्स

Promise<Response>

API रिस्पॉन्स पर resolve होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response

​

यहां परिभाषित है

media/client.ts:442

▸ getUploadStatus(mediaId, options?): Promise<MediaUploadResponse>

​

पैरामीटर

नाम	प्रकार
mediaId	string
options?	GetUploadStatusOptions

​

रिटर्न

Promise<MediaUploadResponse>

​

यहाँ परिभाषित

media/client.ts:455

---

​

upload

▸ upload(options): Promise<Response>

मीडिया अपलोड करें पोस्ट्स या अन्य सामग्री में उपयोग के लिए मीडिया फ़ाइल अपलोड करता है।

​

पैरामीटर्स

नाम	Type
options	UploadOptions & { requestOptions: { raw: true } }

​

रिटर्न

Promise<Response>

API प्रतिक्रिया पर resolve होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response

​

इसमें परिभाषित

media/client.ts:582

▸ upload(options?): Promise<MediaUploadResponse>

​

पैरामीटर

नाम	प्रकार
options?	UploadOptions

​

रिटर्न

Promise<MediaUploadResponse>

​

यहाँ परिभाषित

media/client.ts:591

---

​

getAnalytics

▸ getAnalytics(mediaKeys, endTime, startTime, granularity, options): Promise<Response>

मीडिया विश्लेषिकी प्राप्त करें मीडिया के लिए विश्लेषिकी डेटा प्राप्त करता है।

​

पैरामीटर

नाम	Type	विवरण
mediaKeys	any[]	Media Keys की कॉमा-से-अलग की गई सूची। एक अनुरोध में अधिकतम 100 की अनुमति है।
endTime	string	YYYY-MM-DDTHH:mm:ssZ. समय-सीमा के अंत को दर्शाने वाला UTC टाइमस्टैम्प।
startTime	string	YYYY-MM-DDTHH:mm:ssZ. समय-सीमा की शुरुआत को दर्शाने वाला UTC टाइमस्टैम्प।
granularity	string	खोज गणना परिणामों के लिए ग्रैन्युलैरिटी।
options	GetAnalyticsOptions & { requestOptions: { raw: true } }	-

​

रिटर्न्स

Promise<Response>

वह Promise जो API response पर resolve होता है, या यदि requestOptions.raw true है, तो raw Response

​

में परिभाषित

media/client.ts:699

▸ getAnalytics(mediaKeys, endTime, startTime, granularity, options?): Promise<MediaAnalytics>

​

पैरामीटर

नाम	type
mediaKeys	any[]
endTime	string
startTime	string
granularity	string
options?	GetAnalyticsOptions

​

लौटाता है

Promise<MediaAnalytics>

​

इसमें परिभाषित है

media/client.ts:724

---

​

appendUpload

▸ appendUpload(id, options): Promise<Response>

Media अपलोड में जोड़ें Media अपलोड अनुरोध में डेटा जोड़ता है।

​

पैरामीटर

नाम	Type	विवरण
id	string	उस मीडिया का पहचानकर्ता जिस पर append ऑपरेशन किया जाना है।
options	AppendUploadOptions & { requestOptions: { raw: true } }	-

​

रिटर्न्स

Promise<Response>

API रिस्पॉन्स पर resolve होने वाला Promise, या अगर requestOptions.raw true है, तो raw Response

​

यहाँ परिभाषित है

media/client.ts:918

▸ appendUpload(id, options?): Promise<MediaUploadAppendResponse>

​

पैरामीटर्स

नाम	type
id	string
options?	AppendUploadOptions

​

लौटाया गया मान

Promise<MediaUploadAppendResponse>

​

यहाँ परिभाषित है

media/client.ts:931

---

​

getByKeys

▸ getByKeys(mediaKeys, options): Promise<Response>

मीडिया कुंजियों से Media प्राप्त करें Media फ़ाइलों की मीडिया कुंजियों के आधार पर उनका विवरण प्राप्त करता है।

​

पैरामीटर

नाम	type	विवरण
mediaKeys	any[]	Media Keys की अल्पविराम-से-अलग की गई सूची। एक अनुरोध में अधिकतम 100 की अनुमति है।
options	GetByKeysOptions & { requestOptions: { raw: true } }	-

​

रिटर्न्स

Promise<Response>

API response पर resolve होने वाला Promise, या अगर requestOptions.raw true है, तो raw Response

​

में परिभाषित

media/client.ts:1039

▸ getByKeys(mediaKeys, options?): Promise<Get2MediaResponse>

​

पैरामीटर

नाम	type
mediaKeys	any[]
options?	GetByKeysOptions

​

रिटर्न

Promise<Get2MediaResponse>

​

यहाँ परिभाषित है

media/client.ts:1052

---

​

createMetadata

▸ createMetadata(options): Promise<Response>

Media मेटाडेटा बनाएँ किसी Media फ़ाइल के लिए मेटाडेटा बनाता है।

​

पैरामीटर

नाम	type
options	CreateMetadataOptions & { requestOptions: { raw: true } }

​

रिटर्न

Promise<Response>

ऐसा Promise जो API response पर resolve होता है, या यदि requestOptions.raw true हो, तो raw Response

​

यहाँ परिभाषित है

media/client.ts:1191

▸ createMetadata(options?): Promise<MetadataCreateResponse>

​

पैरामीटर्स

नाम	type
options?	CreateMetadataOptions

​

रिटर्न

Promise<MetadataCreateResponse>

​

में परिभाषित

media/client.ts:1200

---

​

finalizeUpload

▸ finalizeUpload(id, options): Promise<Response>

Media अपलोड को पूरा करें Media अपलोड अनुरोध को पूरा करता है।

​

पैरामीटर

नाम	type	विवरण
id	string	अंतिम रूप देने के लिए लक्षित मीडिया की media id।
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

रिटर्न्स

Promise<Response>

API प्रतिक्रिया पर resolve होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response

​

यहाँ परिभाषित

media/client.ts:1296

▸ finalizeUpload(id): Promise<MediaUploadResponse>

​

पैरामीटर

नाम	प्रकार
id	string

​

रिटर्न्स

Promise<MediaUploadResponse>

​

इसमें परिभाषित है

media/client.ts:1309

---

​

initializeUpload

▸ initializeUpload(options): Promise<Response>

मीडिया अपलोड शुरू करें मीडिया अपलोड शुरू करता है।

​

पैरामीटर

नाम	type
options	InitializeUploadOptions & { requestOptions: { raw: true } }

​

रिटर्न्स

Promise<Response>

API रिस्पॉन्स पर resolve होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response

​

में परिभाषित

media/client.ts:1396

▸ initializeUpload(options?): Promise<MediaUploadResponse>

​

पैरामीटर

नाम	type
options?	InitializeUploadOptions

​

रिटर्न

Promise<MediaUploadResponse>

​

यहाँ परिभाषित है

media/client.ts:1405

---

​

createSubtitles

▸ createSubtitles(options): Promise<Response>

Media के लिए उपशीर्षक बनाएँ किसी विशिष्ट Media फ़ाइल के लिए उपशीर्षक बनाता है।

​

पैरामीटर

नाम	type
options	CreateSubtitlesOptions & { requestOptions: { raw: true } }

​

रिटर्न

Promise<Response>

API response पर resolve होने वाला Promise, या यदि requestOptions.raw true है तो raw Response

​

यहाँ परिभाषित है

media/client.ts:1497

▸ createSubtitles(options?): Promise<SubtitlesCreateResponse>

​

पैरामीटर

नाम	type
options?	CreateSubtitlesOptions

​

रिटर्न

Promise<SubtitlesCreateResponse>

​

यहाँ परिभाषित है

media/client.ts:1506

---

​

deleteSubtitles

▸ deleteSubtitles(options): Promise<Response>

मीडिया के उपशीर्षक हटाएँ किसी विशिष्ट मीडिया फ़ाइल के उपशीर्षक हटाता है।

​

पैरामीटर

नाम	type
options	DeleteSubtitlesOptions & { requestOptions: { raw: true } }

​

रिटर्न

Promise<Response>

API response पर resolve होने वाला Promise, या यदि requestOptions.raw true है, तो raw Response

​

यहाँ परिभाषित है

media/client.ts:1598

▸ deleteSubtitles(options?): Promise<SubtitlesDeleteResponse>

​

पैरामीटर

नाम	type
options?	DeleteSubtitlesOptions

​

रिटर्न्स

Promise<SubtitlesDeleteResponse>

​

यहाँ परिभाषित है

media/client.ts:1607